|
void | Open () |
| Open the port. More...
|
|
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 | ReadUntil (void *const buffer, size_t count, uint8_t terminator) |
| Read data until a specified termination byte is received.
|
|
ssize_t | ReadStringUntil (std::string &buffer, char terminator) |
| Read a string until the specified termination character is received.
|
|
ssize_t | Skip (size_t count) |
| Dump data until the specified number of bytes have been read.
|
|
ssize_t | SkipUntil (uint8_t terminator, unsigned int count) |
| Read and dump data until the specified termination character has been seen count times.
|
|
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.
|
|
virtual ssize_t | ReadString (std::string &buffer) |
| Read a string. More...
|
|
virtual ssize_t | ReadLine (char *const buffer, size_t count) |
| Read a new-line terminated string of data. More...
|
|
virtual ssize_t | ReadLine (std::string &buffer) |
| Read a new-line terminated string of data. More...
|
|
virtual ssize_t | WriteFull (const void *const buffer, size_t count) |
| Write all the data to the port. More...
|
|
virtual ssize_t | WriteString (const char *const buffer) |
| Write a string to the port. More...
|
|
std::string | GetPortType () const |
| Get the port type.
|
|
void | SetDebug (int debug) |
| Set the debug level.
|
|
int | GetDebug () const |
| Get the debug level.
|
|
virtual Timeout | GetTimeout () const |
| Get the timeout.
|
|
virtual bool | IsBlocking () const |
| Get the blocking property of the port. If the timeout is non-zero, the port will block.
|
|
virtual bool | CanRead () const |
| Get the read permissions of the port.
|
|
virtual bool | CanWrite () const |
| Get the write permissions of the port.
|
|
UDP implementation of the Port class. This class provides UDP communication between two known end points. It cannot send to any address other than the configured address.
See the Port class documentation for how to use the common API. Note that some parts of the API do not apply due to the nature of the datagram-oriented protocol. Because each datagram is individual and no merging is typically performed between datagrams, several flexiport functions do not work (they were designed for stream-oriented communications). These are ReadStringUntil, ReadLine (std::string version), Skip, and SkipUntil. This will be (hopefully) be fixed soon.
TODO: Add support for configuring the destination address based on the first data received, to allow destination auto-configuration. TODO: Add an option to turn buffering on, making the UDP protocol function like a stream-based protocol and so enabling the use of those parts of the API that do not function correctly for a datagram-based protocol. Alternatively, fix the functions that don't work yet so they read more than a byte at a time.
- Options
- dest_ip <string>
- IP address to send data to.
- Default: 127.0.0.1
- dest_port <integer>
- UDP port to send data to.
- Default: 20000
- recv_ip <string>
- IP address to receive data on. Set to "*" for receiving on any interface.
- Default: *
- recv_port <integer>
- UDP port to receive data on.
- Default: 20000