stromx  0.8.0
Receive.h
1 /*
2  * Copyright 2013 Matthias Fuchs
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 
17 #ifndef STROMX_RUNTIME_RECEIVE_H
18 #define STROMX_RUNTIME_RECEIVE_H
19 
20 #include "stromx/runtime/OperatorKernel.h"
21 #include "stromx/runtime/String.h"
22 
23 namespace stromx
24 {
25  namespace runtime
26  {
27  namespace impl
28  {
29  class Client;
30  }
31 
33  class STROMX_RUNTIME_API Receive : public OperatorKernel
34  {
35  public:
36  enum DataId
37  {
38  OUTPUT,
39  URL,
40  PORT
41  };
42 
43  Receive();
44  virtual ~Receive();
45 
46  virtual OperatorKernel* clone() const { return new Receive; }
47  virtual void setParameter(const unsigned int id, const Data& value);
48  const DataRef getParameter(const unsigned int id) const;
49  virtual void initialize();
50  virtual void activate();
51  virtual void deactivate();
52  virtual void interrupt();
53  virtual void execute(DataProvider& provider);
54 
55  private:
56  const static std::string LINE_DELIMITER;
57 
58  static const std::vector<const Input*> setupInputs();
59  static const std::vector<const Parameter*> setupParameters();
60  const std::vector<const Output*> setupOutputs() const;
61 
62  static const std::string TYPE;
63  static const std::string PACKAGE;
64  static const Version VERSION;
65 
66  static const unsigned int MIN_PORT;
67  static const unsigned int MAX_PORT;
68 
69  String m_url;
70  UInt16 m_port;
71 
72  impl::Client* m_client;
73  };
74  }
75 }
76 
77 #endif // STROMX_RUNTIME_RECEIVE_H
A version of an operator or data type.
Definition: Version.h:46
Abstract data object.
Definition: Data.h:53
Reference to a data object.
Definition: DataRef.h:48
virtual OperatorKernel * clone() const
Definition: Receive.h:46
Distributes input data to TCP clients.
Definition: Receive.h:33
The stromx class library.
Definition: AdjustRgbChannels.cpp:29
String data value.
Definition: String.h:28
Abstract operator kernel.
Definition: OperatorKernel.h:46
Provider of functions to receive and send data.
Definition: DataProvider.h:35