Methods
Kxs¶
Represents the main client entry point to interact with KX Sensors.
Connect¶
Establishes a connection to a KX Sensors system.
Signature:
bool Connect(SapiConfig config, KxsResponse kxsResponse = null);Parameters:
- config: Configuration details for connection.
- kxsResponse: Response object.
Returns:
- bool: 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.
GetSapiEvents¶
Retrieves the event handlers.
Signature:
Events.Events GetSapiEvents();Returns:
- Events.Events: Returns the event handlers.
Execute¶
Executes an API call on the server.
Signature:
bool Execute(string apiName, c.Dict request = null, c.Dict header = null, bool deserializeResponse = true, RetryPolicy retryPolicy = null, KxsResponse kxsResponse = null);Parameters:
- apiName: Name of the API.
- request: Request to execute.
- header: Dictionary containing values to augment the KXS request header.
- deserializeResponse: Whether the response should be deserialized.
- retryPolicy: Retry policy for API execution.
- kxsResponse: Response object for API execution.
Returns:
- bool: Success indicator.
Publish¶
Publishes data to KX Sensors.
Signature:
bool Publish(IntPtr topicHandle, short msgType, object data, c.Dict header = null, RetryPolicy retryPolicy = null, KxsResponse kxsResponse = null);Parameters:
- topicHandle: Handle for the topic publisher.
- msgType: Message type identifier.
- data: Data to publish.
- header: Publishing header.
- retryPolicy: Retry policy.
- kxsResponse: Response object.
Returns:
- bool: Success indicator.
RegisterPublisher¶
Registers a publisher for a specific topic.
Signature:
IntPtr RegisterPublisher(string topic, KxsResponse kxsResponse = null);Parameters:
- topic: Name of the topic.
- kxsResponse: Response object.
Returns:
- IntPtr: Returns a pointer or handle.
UnregisterPublisher¶
Unregisters a topic publisher.
Signature:
void UnregisterPublisher(IntPtr topicHandle, KxsResponse kxsResponse = null);Parameters:
- topicHandle: Handle for the topic publisher.
- kxsResponse: Response object.
Returns:
- void: No return value.
RegisterQueueListener¶
Registers a listener for queue messages.
Signature:
bool RegisterQueueListener(string queue, Func<IntPtr, string, int, KxsResponse, bool> handler, short ackMode, KxsResponse kxsResponse = null);Parameters:
- queue: Queue name.
- handler: Callback function for queue messages.
- kxsResponse: Response object.
Returns:
- bool: Success indicator.
UnregisterQueueListener¶
Unregisters a queue listener.
Signature:
bool UnregisterQueueListener(string queue, KxsResponse kxsResponse = null);Parameters:
- queue: Queue name.
- kxsResponse: Response object.
Returns:
- bool: Success indicator.
AckQueue¶
Acknowledges receipt of a queue message.
Signature:
static bool AckQueue(IntPtr client, string queue, long id);Parameters:
- client: Handle to client.
- queue: Queue name.
- id: Message identifier.
Returns:
- bool: Success indicator.
RegisterLogHandler¶
Registers a global logging handler.
Signature:
static void RegisterLogHandler(Action<int, string, string> logMessageHandler);Parameters:
- logMessageHandler: Callback for logging messages.
Returns:
- void: No return value.
SetLogLevels¶
Configures logging levels used by SAPI.
Signature:
static void SetLogLevels(short traceLevel, short debugLevel, short infoLevel, short warnLevel, short errorLevel, short fatalLevel);Parameters:
- traceLevel: Level for TRACE logs.
- debugLevel: Level for DEBUG logs.
- infoLevel: Level for INFO logs.
- warnLevel: Level for WARN logs.
- errorLevel: Level for ERROR logs.
- fatalLevel: Level for FATAL logs.
Returns:
- void: No return value.