Neonode zForce(TM) SDK
|
Struct containing the SerialTransport information. More...
#include <SerialTransport.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... | |
int | FileDescriptor |
Instance-specific file descriptor. | |
Struct containing the SerialTransport information.
SerialTransport contains the Transport base, a pointer to the base Transport class.
Transport* SerialTransport::Base |
bool( * SerialTransport::Close) (Transport *self) |
Close the generic Transport.
Close the generic Transport.
Inherited from Transport base class.
On failure, errno is set.
self | Pointer to the struct itself. |
Connection* SerialTransport::Connection |
Each Transport is linked to one Connection.
Each Transport is linked to one Connection.
Inherited from Transport base class.
char SerialTransport::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".
Inherited from Transport base class.
void( * SerialTransport::Destructor) (Transport *self) |
Destructor frees all the resources that have been allocated.
Destructor frees all the resources that have been allocated.
Inherited from Transport base class.
self | Pointer to the struct itself. |
Enqueue given dataframe.
Enqueue given dataframe.
Inherited from Transport base class.
On failure, errno is set.
self | Pointer to the struct itself. |
dataFrame | the data frame to be put in the Write queue |
uint64_t( * SerialTransport::GetTimeOutValue) (Transport *self) |
bool SerialTransport::IsOpen |
bool( * SerialTransport::Open) (Transport *self) |
Open the generic Transport.
Opens the Transport specified by the ConnectionString. The ConnectionString's options are used.
Inherited from Transport base class.
On failure, errno is set.
self | Pointer to the struct itself. |
bool SerialTransport::Opening |
Function pointer to Transport's Read.
Function pointer to Transport's Read.
On failure, errno is set.
self | Pointer to the struct itself. |
zForceThread* SerialTransport::ReadThread |
Read Thread pointer.
Read Thread pointer.
Inherited from Transport base class.
volatile ReadWriteThreadStatus SerialTransport::ReadThreadStatus |
Thread is active.
Thread is active.
Inherited from Transport base class.
bool SerialTransport::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.
Inherited from Transport base class.
volatile bool SerialTransport::Terminate |
void( * SerialTransport::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.
Inherited from Transport base class.
self | Pointer to the struct itself. |
Function pointer to Transport's Write.
Function pointer to Transport's Write.
Inherited from Transport base class.
On failure, errno is set.
self | Pointer to the struct itself. |
payload | The payload pointer. |
Queue* SerialTransport::WriteQueue |
A pointer to the Write queue used by EnqueueDataFrame.
A pointer to the Write queue used by EnqueueDataFrame.
Inherited from Transport base class.
zForceThread* SerialTransport::WriteThread |
Write Thread pointer.
Write Thread pointer.
Inherited from Transport base class.
volatile ReadWriteThreadStatus SerialTransport::WriteThreadStatus |
Thread is active.
Thread is active.
Inherited from Transport base class.
zForce* SerialTransport::zForce |