Variables
void(*	XsCallbackPlainC::m_onAllBufferedDataAvailable )(struct XsCallbackPlainC thisPtr, struct XsDevicePtrArray devs, const struct XsDataPacketPtrArray *packets)
	Called when new data has been received for devices connected to the same main device. When processing on PC is enabled, this callback occurs after processing has been done and so the packet will contain the processing output. More...

void(*	XsCallbackPlainC::m_onAllDataAvailable )(struct XsCallbackPlainC thisPtr, struct XsDevicePtrArray devs, const struct XsDataPacketPtrArray *packets)
	Called when new data has been received for devices connected to the same main device. When processing on PC is enabled, this callback occurs after processing has been done and so the packet will contain the processing output. More...

void(*	XsCallbackPlainC::m_onAllLiveDataAvailable )(struct XsCallbackPlainC thisPtr, struct XsDevicePtrArray devs, const struct XsDataPacketPtrArray *packets)
	Called when new data has been received for devices connected to the same main device. When processing on PC is enabled, this callback occurs after processing has been done and so the packet will contain the processing output. More...

void(*	XsCallbackPlainC::m_onAllRecordedDataAvailable )(struct XsCallbackPlainC thisPtr, struct XsDevicePtrArray devs, const struct XsDataPacketPtrArray *packets)
	Called when new data has been received for devices connected to the same main device in a recording state or read from file. When processing on PC is enabled, this callback occurs after processing has been done and so the packet will contain the processing output. More...

void(*	XsCallbackPlainC::m_onBufferedDataAvailable )(struct XsCallbackPlainC thisPtr, struct XsDevice dev, const struct XsDataPacket *packet)
	Called when XDA has a data packet that could be written to a log file. More...

void(*	XsCallbackPlainC::m_onConnectivityChanged )(struct XsCallbackPlainC thisPtr, struct XsDevice dev, XsConnectivityState newState)
	Called when XDA has detected a change in the connectivity state of a device. More...

void(*	XsCallbackPlainC::m_onDataAvailable )(struct XsCallbackPlainC thisPtr, struct XsDevice dev, const struct XsDataPacket *packet)
	Called when new data has been received from a device or read from a file. When processing on PC is enabled, this callback occurs after processing has been done and so the packet will contain the processing output. More...

void(*	XsCallbackPlainC::m_onDataUnavailable )(struct XsCallbackPlainC thisPtr, struct XsDevice dev, int64_t packetId)
	Called when XDA detects that data is forever unavailable. More...

void(*	XsCallbackPlainC::m_onDeviceStateChanged )(struct XsCallbackPlainC thisPtr, struct XsDevice dev, XsDeviceState newState, XsDeviceState oldState)
	Called when a device's state has changed (ie config mode, measurement mode, recording mode) More...

void(*	XsCallbackPlainC::m_onError )(struct XsCallbackPlainC thisPtr, struct XsDevice dev, XsResultValue error)
	Called when an error has occurred while handling incoming data. More...

void(*	XsCallbackPlainC::m_onInfoResponse )(struct XsCallbackPlainC thisPtr, struct XsDevice dev, XsInfoRequest request)
	Called when an information request has resulted in a response. More...

void(*	XsCallbackPlainC::m_onLiveDataAvailable )(struct XsCallbackPlainC thisPtr, struct XsDevice dev, const struct XsDataPacket *packet)
	Called when new data has been received from a device or read from a file. When processing on PC is enabled, this callback occurs after processing has been done and so the packet will contain the processing output. More...

void(*	XsCallbackPlainC::m_onMessageDetected )(struct XsCallbackPlainC thisPtr, struct XsDevice dev, XsProtocolType type, struct XsByteArray const *rawMessage)
	Called just after a message is detected in raw data from the device. More...

void(*	XsCallbackPlainC::m_onMessageReceivedFromDevice )(struct XsCallbackPlainC thisPtr, struct XsDevice dev, struct XsMessage const *message)
	Called just after a valid message (after parsing) is received from the device. More...

void(*	XsCallbackPlainC::m_onMessageSentToDevice )(struct XsCallbackPlainC thisPtr, struct XsDevice dev, struct XsMessage const *message)
	Called just after a message is sent to the device. More...

void(*	XsCallbackPlainC::m_onMissedPackets )(struct XsCallbackPlainC thisPtr, struct XsDevice dev, int count, int first, int last)
	Called when XDA detects that packets have been missed. More...

void(*	XsCallbackPlainC::m_onNonDataMessage )(struct XsCallbackPlainC thisPtr, struct XsDevice dev, struct XsMessage const *message)
	Called when a non data, non reply message has been received. More...

void(*	XsCallbackPlainC::m_onProgressUpdated )(struct XsCallbackPlainC thisPtr, struct XsDevice dev, int current, int total, const struct XsString *identifier)
	Called when a long-duration operation has made some progress or has completed. Examples include loadLogFile and flushing of retransmissions (Awinda). When current == total the operation has completed. More...

void(*	XsCallbackPlainC::m_onRecordedDataAvailable )(struct XsCallbackPlainC thisPtr, struct XsDevice dev, const struct XsDataPacket *packet)
	Called when new data has been received from a device in a recording state or read from a file. When processing on PC is enabled, this callback occurs after processing has been done and so the packet will contain the processing output. More...

void(*	XsCallbackPlainC::m_onRestoreCommunication )(struct XsCallbackPlainC thisPtr, const struct XsString portName, XsResultValue result)
	Called when restore communication is completed, stopped or an error occurred. More...

void(*	XsCallbackPlainC::m_onTransmissionRequest )(struct XsCallbackPlainC thisPtr, int channelId, const struct XsByteArray data)
	Called when XDA needs to send raw data to a device connected using a custom communication channel. More...

void(*	XsCallbackPlainC::m_onWakeupReceived )(struct XsCallbackPlainC thisPtr, struct XsDevice dev)
	Called when a wakeup message has been received from a device. This indicates that the device has just been reset or plugged in. More...

int(*	XsCallbackPlainC::m_onWriteMessageToLogFile )(struct XsCallbackPlainC thisPtr, struct XsDevice dev, const struct XsMessage *message)
	Called when XDA has a message that could be written to a log file. More...

Detailed Description

Variable Documentation

◆ m_onAllBufferedDataAvailable

void(* XsCallbackPlainC::m_onAllBufferedDataAvailable) (struct XsCallbackPlainC *thisPtr, struct XsDevicePtrArray *devs, const struct XsDataPacketPtrArray *packets)

Called when new data has been received for devices connected to the same main device. When processing on PC is enabled, this callback occurs after processing has been done and so the packet will contain the processing output.

This callback is for the Buffered stream, which will attempt to retransmit missed data when in Recording mode. So there should be no gaps (when recording), but the data arrival may be delayed a bit. When not recording, the behaviour is identical to the Live stream. This stream will only interpolate data that is knon to be permanently unavailable.

Parameters

devs	A managed array of devices for which data is available. The array will be cleaned up by XDA after the callback returns.
packets	A plain array of pointers to data packets matching the order of devs. The array will be cleaned up by XDA after the callback returns.

See also: m_onAllLiveDataAvailable; m_onLiveDataAvailable; m_onBufferedDataAvailable; m_onDataAvailable

Note: For most applications, attaching to the m_onAllDataAvailable callback is sufficient, the specific stream callbacks are only provided for exceptional cases

Definition at line 222 of file xscallbackplainc.h.

◆ m_onAllDataAvailable

void(* XsCallbackPlainC::m_onAllDataAvailable) (struct XsCallbackPlainC *thisPtr, struct XsDevicePtrArray *devs, const struct XsDataPacketPtrArray *packets)

Called when new data has been received for devices connected to the same main device. When processing on PC is enabled, this callback occurs after processing has been done and so the packet will contain the processing output.

This callback is dynamically attached to either the Live or the Buffered stream and behaves accordingly. When reading from a device, it will be attached to the Live stream, while it will be attached to the Buffered stream when reading from a file.

Parameters

devs	A managed array of devices for which data is available. The array will be cleaned up by XDA after the callback returns.
packets	A plain array of pointers to data packets matching the order of devs. The array will be cleaned up by XDA after the callback returns.

See also: m_onAllLiveDataAvailable; m_onAllBufferedDataAvailable; m_onDataAvailable

Definition at line 246 of file xscallbackplainc.h.

◆ m_onAllLiveDataAvailable

void(* XsCallbackPlainC::m_onAllLiveDataAvailable) (struct XsCallbackPlainC *thisPtr, struct XsDevicePtrArray *devs, const struct XsDataPacketPtrArray *packets)

Called when new data has been received for devices connected to the same main device. When processing on PC is enabled, this callback occurs after processing has been done and so the packet will contain the processing output.

This callback is for the Live stream, so there may be gaps in the data, but it will always contain the latest data. This stream will interpolate missing data to provide the fastest data output.

Parameters

devs	A managed array of devices for which data is available. The array will be cleaned up by XDA after the callback returns.
packets	A plain array of pointers to data packets matching the order of devs. The array will be cleaned up by XDA after the callback returns.

See also: m_onLiveDataAvailable; m_onBufferedDataAvailable; m_onAllBufferedDataAvailable; m_onDataAvailable

Note: For most applications, attaching to the m_onAllDataAvailable callback is sufficient, the specific stream callbacks are only provided for exceptional cases

Definition at line 213 of file xscallbackplainc.h.

◆ m_onAllRecordedDataAvailable

void(* XsCallbackPlainC::m_onAllRecordedDataAvailable) (struct XsCallbackPlainC *thisPtr, struct XsDevicePtrArray *devs, const struct XsDataPacketPtrArray *packets)

Called when new data has been received for devices connected to the same main device in a recording state or read from file. When processing on PC is enabled, this callback occurs after processing has been done and so the packet will contain the processing output.

This callback is attached to the Buffered stream and behaves accordingly, it will only be called with data that should be recorded.

Parameters

devs	A managed array of devices for which data is available. The array will be cleaned up by XDA after the callback returns.
packets	A plain array of pointers to data packets matching the order of devs. The array will be cleaned up by XDA after the callback returns.

See also: m_onAllLiveDataAvailable; m_onAllBufferedDataAvailable; m_onDataAvailable

Definition at line 262 of file xscallbackplainc.h.

◆ m_onBufferedDataAvailable

void(* XsCallbackPlainC::m_onBufferedDataAvailable) (struct XsCallbackPlainC *thisPtr, struct XsDevice *dev, const struct XsDataPacket *packet)

Called when XDA has a data packet that could be written to a log file.

This callback is for the Buffered stream, which will attempt to retransmit missed data when in Recording mode. So there should be no gaps (when recording), but the data arrival may be delayed a bit. When not recording, the behaviour is identical to the Live stream.

Parameters

dev	The device that initiated the callback.
packet	The data message that is ready to be written to file

See also: onWriteMessageToLogFile; m_onAllLiveDataAvailable; m_onLiveDataAvailable; m_onAllBufferedDataAvailable; m_onDataAvailable

Note: For most applications, attaching to the m_onDataAvailable callback is sufficient, the specific stream callbacks are only provided for exceptional cases

Definition at line 157 of file xscallbackplainc.h.

◆ m_onConnectivityChanged

void(* XsCallbackPlainC::m_onConnectivityChanged) (struct XsCallbackPlainC *thisPtr, struct XsDevice *dev, XsConnectivityState newState)

Called when XDA has detected a change in the connectivity state of a device.

Parameters

dev	The device that initiated the callback.
newState	The new connectivity state

Definition at line 163 of file xscallbackplainc.h.

◆ m_onDataAvailable

void(* XsCallbackPlainC::m_onDataAvailable) (struct XsCallbackPlainC *thisPtr, struct XsDevice *dev, const struct XsDataPacket *packet)

Called when new data has been received from a device or read from a file. When processing on PC is enabled, this callback occurs after processing has been done and so the packet will contain the processing output.

This callback is dynamically attached to either the Live or the Buffered stream and behaves accordingly. When reading from a device, it will be attached to the Live stream, while it will be attached to the Buffered stream when reading from a file.

Parameters

dev	The device that initiated the callback.
packet	The data packet that has been received (and processed). This may be 0 when the callback originates from a non-device, such as the XsDataBundler.

See also: m_onAllLiveDataAvailable; m_onLiveDataAvailable; m_onAllBufferedDataAvailable; m_onBufferedDataAvailable; m_onAllDataAvailable

Definition at line 238 of file xscallbackplainc.h.

◆ m_onDataUnavailable

void(* XsCallbackPlainC::m_onDataUnavailable) (struct XsCallbackPlainC *thisPtr, struct XsDevice *dev, int64_t packetId)

Called when XDA detects that data is forever unavailable.

This differs from onMissedPackets, since missed packets may be retransmitted, while unavailable data can no longer be retransmitted.

Parameters

dev	The device that initiated the callback.
packetId	The sample counter / packet identifier of the unavailable sample

Definition at line 230 of file xscallbackplainc.h.

◆ m_onDeviceStateChanged

void(* XsCallbackPlainC::m_onDeviceStateChanged) (struct XsCallbackPlainC *thisPtr, struct XsDevice *dev, XsDeviceState newState, XsDeviceState oldState)

Called when a device's state has changed (ie config mode, measurement mode, recording mode)

Parameters

dev	The device that initiated the callback. This may be 0 in some cases.
newState	The new device state
oldState	The old device state

Definition at line 110 of file xscallbackplainc.h.

◆ m_onError

void(* XsCallbackPlainC::m_onError) (struct XsCallbackPlainC *thisPtr, struct XsDevice *dev, XsResultValue error)

Called when an error has occurred while handling incoming data.

Parameters

dev	The device that generated the error message
error	The error code that specifies exactly what problem occurred

Definition at line 178 of file xscallbackplainc.h.

◆ m_onInfoResponse

void(* XsCallbackPlainC::m_onInfoResponse) (struct XsCallbackPlainC *thisPtr, struct XsDevice *dev, XsInfoRequest request)

Called when an information request has resulted in a response.

When the information request has completed, the data can be retrieved through the usual functions. Ie. when a requestBatteryLevel() resulted in an onInfoResponse(.., XIR_BatteryLevel), the XsDevice::batteryLevel function will return the received battery level.

Parameters

dev	The device that initiated the callback.
request	The type of request that was completed

Definition at line 172 of file xscallbackplainc.h.

◆ m_onLiveDataAvailable

void(* XsCallbackPlainC::m_onLiveDataAvailable) (struct XsCallbackPlainC *thisPtr, struct XsDevice *dev, const struct XsDataPacket *packet)

Called when new data has been received from a device or read from a file. When processing on PC is enabled, this callback occurs after processing has been done and so the packet will contain the processing output.

This callback is for the Live stream, so there may be gaps in the data, but it will always contain the latest data.

Parameters

dev	The device that initiated the callback.
packet	The data packet that has been received (and processed). This may be 0 when the callback originates from a non-device, such as the XsDataBundler.

Note: For most applications, attaching to the m_onDataAvailable callback is sufficient, the specific stream callbacks are only provided for exceptional cases

See also: m_onAllLiveDataAvailable; m_onBufferedDataAvailable; m_onAllBufferedDataAvailable; m_onDataAvailable

Definition at line 119 of file xscallbackplainc.h.

◆ m_onMessageDetected

void(* XsCallbackPlainC::m_onMessageDetected) (struct XsCallbackPlainC *thisPtr, struct XsDevice *dev, XsProtocolType type, struct XsByteArray const *rawMessage)

Called just after a message is detected in raw data from the device.

Parameters

dev	The device that sent the message
type	The protocol type that detected a message
rawMessage	The raw message that has been detected

Note: This message can be invalid, since it wasn't checked for sanity

Definition at line 192 of file xscallbackplainc.h.

◆ m_onMessageReceivedFromDevice

void(* XsCallbackPlainC::m_onMessageReceivedFromDevice) (struct XsCallbackPlainC *thisPtr, struct XsDevice *dev, struct XsMessage const *message)

Called just after a valid message (after parsing) is received from the device.

Parameters

dev	The device that sent the message
message	The message that has been received

Definition at line 198 of file xscallbackplainc.h.

◆ m_onMessageSentToDevice

void(* XsCallbackPlainC::m_onMessageSentToDevice) (struct XsCallbackPlainC *thisPtr, struct XsDevice *dev, struct XsMessage const *message)

Called just after a message is sent to the device.

Parameters

dev	The device that will receive the message
message	The message that will be sent

Definition at line 204 of file xscallbackplainc.h.

◆ m_onMissedPackets

void(* XsCallbackPlainC::m_onMissedPackets) (struct XsCallbackPlainC *thisPtr, struct XsDevice *dev, int count, int first, int last)

Called when XDA detects that packets have been missed.

Parameters

dev	The device that initiated the callback.
count	The number of samples that were missed
first	The sample counter / packet identifier of the first missed sample
last	The sample counter / packet identifier of the last missed sample

Definition at line 127 of file xscallbackplainc.h.

◆ m_onNonDataMessage

void(* XsCallbackPlainC::m_onNonDataMessage) (struct XsCallbackPlainC *thisPtr, struct XsDevice *dev, struct XsMessage const *message)

Called when a non data, non reply message has been received.

Parameters

dev	The device that generated the error message
message	The message that has been received

Definition at line 184 of file xscallbackplainc.h.

◆ m_onProgressUpdated

void(* XsCallbackPlainC::m_onProgressUpdated) (struct XsCallbackPlainC *thisPtr, struct XsDevice *dev, int current, int total, const struct XsString *identifier)

Called when a long-duration operation has made some progress or has completed. Examples include loadLogFile and flushing of retransmissions (Awinda). When current == total the operation has completed.

Parameters

dev	The device that initiated the callback.
current	The current progress.
total	The total work to be done. When current equals total, the task is completed.
identifier	An identifier for the task. This may for example be a filename for file read operations.

Definition at line 140 of file xscallbackplainc.h.

◆ m_onRecordedDataAvailable

void(* XsCallbackPlainC::m_onRecordedDataAvailable) (struct XsCallbackPlainC *thisPtr, struct XsDevice *dev, const struct XsDataPacket *packet)

Called when new data has been received from a device in a recording state or read from a file. When processing on PC is enabled, this callback occurs after processing has been done and so the packet will contain the processing output.

This callback is attached to the Buffered stream and behaves accordingly, it will only be called with data that should be recorded.

Parameters

dev	The device that initiated the callback.
packet	The data packet that has been received (and processed). This may be 0 when the callback originates from a non-device, such as the XsDataBundler.

See also: m_onAllLiveDataAvailable; m_onLiveDataAvailable; m_onAllBufferedDataAvailable; m_onBufferedDataAvailable; m_onAllDataAvailable

Definition at line 254 of file xscallbackplainc.h.

◆ m_onRestoreCommunication

void(* XsCallbackPlainC::m_onRestoreCommunication) (struct XsCallbackPlainC *thisPtr, const struct XsString *portName, XsResultValue result)

Called when restore communication is completed, stopped or an error occurred.

Parameters

portName	A name of port to which device is attached.
result	The result code.

Definition at line 274 of file xscallbackplainc.h.

◆ m_onTransmissionRequest

void(* XsCallbackPlainC::m_onTransmissionRequest) (struct XsCallbackPlainC *thisPtr, int channelId, const struct XsByteArray *data)

Called when XDA needs to send raw data to a device connected using a custom communication channel.

Parameters

channelId	The user provided identifier associated with the custom channel.
data	The array of bytes that must be forwarded to the device

Definition at line 268 of file xscallbackplainc.h.

◆ m_onWakeupReceived

void(* XsCallbackPlainC::m_onWakeupReceived) (struct XsCallbackPlainC *thisPtr, struct XsDevice *dev)

Called when a wakeup message has been received from a device. This indicates that the device has just been reset or plugged in.

Parameters

dev	The device that initiated the callback.

Definition at line 132 of file xscallbackplainc.h.

◆ m_onWriteMessageToLogFile

int(* XsCallbackPlainC::m_onWriteMessageToLogFile) (struct XsCallbackPlainC *thisPtr, struct XsDevice *dev, const struct XsMessage *message)

Called when XDA has a message that could be written to a log file.

Parameters

dev	The device that initiated the callback.
message	The message that will be written.

Returns: true if the write to file should be allowed. Note that if ANY callback decides that the write is not allowed, it will be disallowed.

See also: m_onWriteDataToLogFile

Definition at line 148 of file xscallbackplainc.h.

Variables

Detailed Description

Variable Documentation

◆ m_onAllBufferedDataAvailable

◆ m_onAllDataAvailable

◆ m_onAllLiveDataAvailable

◆ m_onAllRecordedDataAvailable

◆ m_onBufferedDataAvailable

◆ m_onConnectivityChanged

◆ m_onDataAvailable

◆ m_onDataUnavailable

◆ m_onDeviceStateChanged

◆ m_onError

◆ m_onInfoResponse

◆ m_onLiveDataAvailable

◆ m_onMessageDetected

◆ m_onMessageReceivedFromDevice

◆ m_onMessageSentToDevice

◆ m_onMissedPackets

◆ m_onNonDataMessage

◆ m_onProgressUpdated

◆ m_onRecordedDataAvailable

◆ m_onRestoreCommunication

◆ m_onTransmissionRequest

◆ m_onWakeupReceived

◆ m_onWriteMessageToLogFile