Methods
connect¶
Establishes a connection to a KX Sensors system.
Signature:
boolean connect(SapiConfig sapiConfig, KxsResponse kxsResponse);Parameters:
- sapiConfig: Configuration details for connection.
- kxsResponse: Optional structure for receiving status or response.
Returns:
- boolean: Success indicator.
disconnect¶
Disconnects from KX Sensors and stops active subscriptions.
Signature:
void disconnect();Returns:
- void: No return value.
getTcpEndpoint¶
Retrieves TCP endpoint details.
Signature:
String getTcpEndpoint();Returns:
- String: Returns requested details as a string.
execute¶
Executes an API call on the server.
Signature:
boolean execute(String apiName, c.Dict params, c.Dict header, RetryPolicy retryPolicy, KxsResponse kxsResponse);Parameters:
- apiName: Name of the API.
- params: Parameters for the API call.
- header: Header augmentation.
- retryPolicy: Retry policy for the operation.
- kxsResponse: Optional structure for receiving status or response.
Returns:
- boolean: Success indicator.
publish¶
Publishes data to KX Sensors.
Signature:
boolean publish(long topicHandle, short msgType, Object data, c.Dict header, KxsResponse response);Parameters:
- topicHandle: Topic handle identifier.
- msgType: Message type identifier.
- data: Data payload to be published.
- header: Header augmentation.
- response: Optional result status.
Returns:
- boolean: Success indicator.
publish¶
Publishes data to KX Sensors.
Signature:
boolean publish(long topicHandle, short msgType, Object data, c.Dict header, RetryPolicy retryPolicy, KxsResponse kxsResponse);Parameters:
- topicHandle: Topic handle identifier.
- msgType: Message type identifier.
- data: Data payload to be published.
- header: Header augmentation.
- retryPolicy: Retry policy for the operation.
- kxsResponse: Optional structure for receiving status or response.
Returns:
- boolean: Success indicator.
registerPublisher¶
Registers a publisher for a specific topic.
Signature:
long registerPublisher(String topic, KxsResponse kxsResponse);Parameters:
- topic: Name of the topic to register.
- kxsResponse: Optional structure for receiving status or response.
Returns:
- long: Returns a handle or identifier.
unregisterPublisher¶
Unregisters a topic publisher.
Signature:
boolean unregisterPublisher(long topicHandle, KxsResponse kxsResponse);Parameters:
- topicHandle: Topic handle identifier.
- kxsResponse: Optional structure for receiving status or response.
Returns:
- boolean: Success indicator.
registerQueueListener¶
Registers a listener for queue messages.
Signature:
boolean registerQueueListener(String queue, KxsQueueListener listener, AckMode ackMode, KxsResponse response);Parameters:
- queue: Queue name.
- listener: Queue message listener.
- ackMode: Acknowledgment mode for queue messages.
- response: Optional result status.
Returns:
- boolean: Success indicator.
unregisterQueueListener¶
Unregisters a queue listener.
Signature:
boolean unregisterQueueListener(String queue, KxsResponse response);Parameters:
- queue: Queue name.
- response: Optional result status.
Returns:
- boolean: Success indicator.
ackQueueMessage¶
Acknowledges receipt of a queue message.
Signature:
boolean ackQueueMessage(String queue, long messageId);Parameters:
- queue: Queue name.
- messageId: Identifier of the queue message.
Returns:
- boolean: Success indicator.