Member Function Documentation

TCPTransport::TCPTransport(const std::function<unsigned int( Transport *, char *, unsigned int ) > readCallbackHandler)

Constructs the TCP Transport, passing in the readCallbackHandler

[override virtual] void TCPTransport::Close()

Reimplemented from Transport::Close().

Closes the socket(s)

[override virtual] std::string TCPTransport::GetNodeTypeName() const

Reimplemented from ICDPNode::GetNodeTypeName().

Returns "TCPTransport"

[override virtual] bool TCPTransport::IsError()

Reimplemented from Transport::IsError().

Returns true if there is a socket error, false if not.

[override virtual] bool TCPTransport::IsOpen() const

Reimplemented from Transport::IsOpen().

Returns true if tcpconnection is connected, false if not.

[override virtual] bool TCPTransport::Open(Transport::OpenMode mode)

Reimplemented from Transport::Open().

Tries to connect the TCP connection to the configured IP/port

[override virtual] unsigned int TCPTransport::Read(char *data, unsigned int length, double timeout = 0.0)

Reimplemented from Transport::Read().

Reads length bytes of data from the tcp socket within timeout [seconds]. If timeout<=0.0, the timeout from the configuration is used. Returns number of bytes read.

It is assumed that data is a buffer that the caller has allocated, and that it is at least length bytes long. Read will block for how long it takes to read the data, or for timeout seconds, whichever comes first.

As Read() is a blocking call, do not call it from a Process() function. See CDPComponent and OSAPIThread for more information about component threads.

[override virtual] unsigned int TCPTransport::Write(const char *data, unsigned int length, double timeout = 0.0)

Reimplemented from Transport::Write().

Sends the data to the configured ip/port unless there is a timeout Returns amount of bytes sent.

It is assumed that data is a buffer that the caller has allocated, and that it is at least length bytes long. Write will block for up to timeout seconds for the output to be ready before attempting to write the data.

As Write() is a blocking call, do not call it from a Process() function. See CDPComponent and OSAPIThread for more information about component threads.