INTRODUCTION Overview Download and Install Documentation Publications REPOSITORY Libraries DEVELOPER Dev Guide Dashboard PEOPLE Contributors Users Project Download Mailing lists
|
tcpport.h 11 * This work is a product of the National Institute of Advanced Industrial Science and Technology,
16 * flexiport is free software: you can redistribute it and/or modify it under the terms of the GNU
virtual ssize_t WriteString(const char *const buffer) Write a string to the port. Definition: port.cpp:331 virtual ssize_t ReadLine(char *const buffer, size_t count) Read a new-line terminated string of data. Definition: port.cpp:201 FlexiPort data communications library. ssize_t BytesAvailableWait() Get the number of bytes waiting after blocking for the timeout. Definition: tcpport.cpp:380 std::string GetStatus() const Get the status of the port (type, device, etc). Definition: tcpport.cpp:514 void Drain() Drain the port's input and output buffers. Definition: tcpport.cpp:503 ssize_t ReadFull(void *const buffer, size_t count) Read the requested quantity of data from the port. Definition: tcpport.cpp:282 virtual ssize_t BytesAvailableWait()=0 Get the number of bytes waiting after blocking for the timeout. Exception thrown by the Port class and its derivatives. Definition: flexiport.h:55 void SetCanWrite(bool canWrite) Set the write permissions of the port. Definition: tcpport.cpp:537 void SetTimeout(Timeout timeout) Set the timeout value in milliseconds. Definition: tcpport.cpp:526 virtual ssize_t ReadStringUntil(std::string &buffer, char terminator) Read a string until the specified termination character is received. Definition: port.cpp:160 virtual ssize_t ReadString(std::string &buffer) Read a string. Definition: port.cpp:72 virtual ssize_t BytesAvailable()=0 Get the number of bytes waiting to be read at the port. Returns immediatly. void Flush() Flush the port's input and output buffers, discarding all data. Definition: tcpport.cpp:472 FLEXIPORT_EXPORT Port * CreatePort(std::string options) Overloaded factory function. Accepts options as a string. ssize_t Read(void *const buffer, size_t count) Read from the port. Definition: tcpport.cpp:206 virtual ssize_t ReadUntil(void *const buffer, size_t count, uint8_t terminator) Read data until a specified termination byte is received. Definition: port.cpp:115 void SetCanRead(bool canRead) Set the read permissions of the port. Definition: tcpport.cpp:532 ssize_t BytesAvailable() Get the number of bytes waiting to be read at the port. Returns immediatly. Definition: tcpport.cpp:349 ssize_t Write(const void *const buffer, size_t count) Write data to the port. Definition: tcpport.cpp:427 virtual ssize_t ReadFull(void *const buffer, size_t count)=0 Read the requested quantity of data from the port. virtual ssize_t Write(const void *const buffer, size_t count)=0 Write data to the port. virtual std::string GetStatus() const Get the status of the port (type, device, etc). Definition: port.cpp:352 |