Neonode zForce(TM) SDK
|
Transport struct. This structure represents the base class of all Transport definitions. More...
#include <Transport.h>
Public Attributes | |
Transport * | Base |
Base pointer to the immediate base Transport class. More... | |
Connection * | Connection |
Each Transport is linked to one Connection. More... | |
zForce * | zForce |
A pointer to the global zForce instance. More... | |
char | ConnectionString [TRANSPORTPROTOCOL_MaxOptionParameterLength+1] |
Connection string. More... | |
volatile bool | Terminate |
A flag indicating if the Transport Read and Write threads should terminate (true) or not (false). More... | |
Queue * | WriteQueue |
A pointer to the Write queue used by EnqueueDataFrame. More... | |
bool | IsOpen |
A flag indicating if the Transport is open (true) or not (false). More... | |
bool | Opening |
Transport is in Opening phase. More... | |
zForceThread * | WriteThread |
Write Thread pointer. More... | |
zForceThread * | ReadThread |
Read Thread pointer. More... | |
volatile ReadWriteThreadStatus | WriteThreadStatus |
Thread is active. More... | |
volatile ReadWriteThreadStatus | ReadThreadStatus |
Thread is active. More... | |
bool(* | Open )(Transport *self) |
Open the generic Transport. More... | |
bool(* | Close )(Transport *self) |
Close the generic Transport. More... | |
DataFrame *(* | Read )(Transport *self) |
Function pointer to Transport's Read. More... | |
bool(* | Write )(Transport *self, DataFrame *payload) |
Function pointer to Transport's Write. More... | |
uint64_t(* | GetTimeOutValue )(Transport *self) |
Function pointer to Transport's GetTimeOutValue. More... | |
bool(* | EnqueueDataFrame )(Transport *self, DataFrame *dataFrame) |
Enqueue given dataframe. More... | |
void(* | Destructor )(Transport *self) |
Destructor frees all the resources that have been allocated. More... | |
void(* | TransportLost )(Transport *self) |
Signals the transport that it has been lost and acts accordingly. More... | |
bool | StopCommunication |
Boolean value that indicates that there is no longer any communication. Internal use only. More... | |
Transport* Transport::Base |
bool( * Transport::Close) (Transport *self) |
Close the generic Transport.
Close the generic Transport.
On failure, errno is set.
self | Pointer to the struct itself. |
Connection* Transport::Connection |
Each Transport is linked to one Connection.
Each Transport is linked to one Connection.
char Transport::ConnectionString[TRANSPORTPROTOCOL_MaxOptionParameterLength+1] |
Connection string.
Connection string. This string contain the type of transport and the option parameters on the following form: type://port=portOption e.g "serial://port=/dev/ttyACM0".
void( * Transport::Destructor) (Transport *self) |
Destructor frees all the resources that have been allocated.
Destructor frees all the resources that have been allocated.
self | Pointer to the struct itself. |
Enqueue given dataframe.
Enqueue given dataframe.
On failure, errno is set.
self | Pointer to the struct itself. |
dataFrame | the data frame to be put in the Write queue |
uint64_t( * Transport::GetTimeOutValue) (Transport *self) |
bool Transport::IsOpen |
bool( * Transport::Open) (Transport *self) |
Open the generic Transport.
Opens the Transport specified by the ConnectionString. The ConnectionString's options are used.
On failure, errno is set.
self | Pointer to the struct itself. |
Function pointer to Transport's Read.
Function pointer to Transport's Read.
On failure, errno is set.
self | Pointer to the struct itself. |
zForceThread* Transport::ReadThread |
Read Thread pointer.
Read Thread pointer.
volatile ReadWriteThreadStatus Transport::ReadThreadStatus |
Thread is active.
Thread is active.
bool Transport::StopCommunication |
Boolean value that indicates that there is no longer any communication. Internal use only.
Boolean value that indicates that there is no longer any communication. Internal use only.
volatile bool Transport::Terminate |
void( * Transport::TransportLost) (Transport *self) |
Signals the transport that it has been lost and acts accordingly.
Signals the transport that it has been lost and acts accordingly.
self | Pointer to the struct itself. |
Function pointer to Transport's Write.
Function pointer to Transport's Write.
On failure, errno is set.
self | Pointer to the struct itself. |
payload | The payload pointer. |
Queue* Transport::WriteQueue |
A pointer to the Write queue used by EnqueueDataFrame.
A pointer to the Write queue used by EnqueueDataFrame.
zForceThread* Transport::WriteThread |
Write Thread pointer.
Write Thread pointer.
volatile ReadWriteThreadStatus Transport::WriteThreadStatus |
Thread is active.
Thread is active.
zForce* Transport::zForce |