Gocator API
|
Represents a data/health receiver.
Inherits kObject.
Public Member Functions | |
kStatus | GoReceiver_Close (GoReceiver receiver) |
Closes the data connection. More... | |
kStatus | GoReceiver_Construct (GoReceiver *receiver, kAlloc allocator) |
Constructs a GoReceiver object. More... | |
kBool | GoReceiver_IsOpen (GoReceiver receiver) |
Reports whether the receiver object has been opened. More... | |
kStatus | GoReceiver_Open (GoReceiver receiver, kIpAddress address, k32u port) |
Opens a data connection to the specified sensor IP address and port. More... | |
kStatus | GoReceiver_SetBuffers (GoReceiver receiver, kSSize socketSize, kSSize clientSize) |
Sets the size of buffers used for receiving data. More... | |
kStatus | GoReceiver_SetCancelHandler (GoReceiver receiver, kCallbackFx function, kPointer context) |
Sets an I/O cancellation query handler for this receiver object. More... | |
kStatus | GoReceiver_SetMessageHandler (GoReceiver receiver, GoReceiverMessageFx function, kPointer context) |
Sets a callback function that can be used to receive notifications when data is available to be read. More... | |
kStatus GoReceiver_Close | ( | GoReceiver | receiver | ) |
Closes the data connection.
receiver | Receiver object. |
kStatus GoReceiver_Construct | ( | GoReceiver * | receiver, |
kAlloc | allocator | ||
) |
Constructs a GoReceiver object.
receiver | Receives constructed receiver object. |
allocator | Memory allocator (or kNULL for default) |
kBool GoReceiver_IsOpen | ( | GoReceiver | receiver | ) |
Reports whether the receiver object has been opened.
receiver | Receiver object. |
kStatus GoReceiver_Open | ( | GoReceiver | receiver, |
kIpAddress | address, | ||
k32u | port | ||
) |
Opens a data connection to the specified sensor IP address and port.
receiver | Receiver object. |
address | Sensor IP address. |
port | Sensor data port. |
kStatus GoReceiver_SetBuffers | ( | GoReceiver | receiver, |
kSSize | socketSize, | ||
kSSize | clientSize | ||
) |
Sets the size of buffers used for receiving data.
Call this function before calling GoReceiver_Open.
receiver | Receiver object. |
socketSize | Size of the read buffer used by the underlying operating system socket (-1 to leave unchanged). |
clientSize | Size of the read buffer used by the receiver object (-1 to leave unchanged). |
kStatus GoReceiver_SetCancelHandler | ( | GoReceiver | receiver, |
kCallbackFx | function, | ||
kPointer | context | ||
) |
Sets an I/O cancellation query handler for this receiver object.
The I/O cancellation query handler will be polled periodically when I/O is blocked for a non-negligible amount of time. If the cancellation handler returns kERROR_ABORT, ongoing communication will be terminated.
receiver | Receiver object. |
function | I/O cancellation callback function (or kNULL to unregister). |
context | Context argument for callback (function receiver). |
kStatus GoReceiver_SetMessageHandler | ( | GoReceiver | receiver, |
GoReceiverMessageFx | function, | ||
kPointer | context | ||
) |
Sets a callback function that can be used to receive notifications when data is available to be read.
receiver | Receiver object. |
function | Data callback function (or kNULL to unregister). |
context | Context argument for callback (function receiver). |