Download and Install


Dev Guide

Users Logo
Mailing lists



flexiport::TCPPort Class Reference

TCP implementation of the Port class. More...

#include <tcpport.h>

Inherits flexiport::Port.

List of all members.

Public Member Functions

void Open ()
 Open the port.
void Close ()
 Close the port.
ssize_t Read (void *const buffer, size_t count)
 Read from the port.
ssize_t ReadFull (void *const buffer, size_t count)
 Read the requested quantity of data from the port.
ssize_t BytesAvailable ()
 Get the number of bytes waiting to be read at the port. Returns immediatly.
ssize_t BytesAvailableWait ()
 Get the number of bytes waiting after blocking for the timeout.
ssize_t Write (const void *const buffer, size_t count)
 Write data to the port.
void Flush ()
 Flush the port's input and output buffers, discarding all data.
void Drain ()
 Drain the port's input and output buffers.
std::string GetStatus () const
 Get the status of the port (type, device, etc).
void SetTimeout (Timeout timeout)
 Set the timeout value in milliseconds.
void SetCanRead (bool canRead)
 Set the read permissions of the port.
void SetCanWrite (bool canWrite)
 Set the write permissions of the port.
bool IsOpen () const
 Check if the port is open.

Detailed Description

TCP implementation of the Port class.

See the Port class documentation for how to use the common API.

  • ip <string>
    • IP address to connect to. If listen is true, set to "*" to listen on any interface.
    • Default:
  • port <integer>
    • TCP port to connect to/listen on.
    • Default: 20000
  • listen
    • Listen on the specified port rather than connecting to it. Other network applications can connect and send data, which will become available as normal.
    • Default: off

Member Function Documentation

void flexiport::TCPPort::Open ( void   )  [virtual]

Open the port.

For a listening port, this will call accept() and therefore cause the calling process to block until an incoming connection.

Implements flexiport::Port.

Referenced by Read(), and ReadFull().

The documentation for this class was generated from the following files:

Generated for GearBox by  doxygen 1.4.5