Skip to content

Python — Methods

This page lists the primary methods available in the SAPI client class.

connect()

Connect to the KX Sensors system using the provided configuration.

Signature

connect(config: SAPIConfig, response: Optional[KxsResponse] = None) -> bool
Parameters

  • config (SAPIConfig)
  • response (Optional[KxsResponse])

Returns

  • bool

disconnect()

Disconnect from the server and release all resources.

Signature

disconnect() -> None
Returns

  • None

execute()

Execute a request synchronously against the connected system.

Signature

execute(req_corr: int, api_name: str, request: pykx.Dictionary, header: Optional[pykx.Dictionary] = None, retry_policy: 'Optional[SAPIRetryPolicy]' = None, response: 'Optional[KxsResponse]' = None) -> bool
Parameters

  • req_corr (int)
  • api_name (str)
  • request (pykx.Dictionary)
  • header (Optional[pykx.Dictionary])
  • retry_policy ('Optional[SAPIRetryPolicy]')
  • response ('Optional[KxsResponse]')

Returns

  • bool

register_publisher()

Register a publisher for sending data to a stream or feed.

Signature

register_publisher(topic_name: str, response: Optional['KxsResponse'] = None) -> TopicHandle
Parameters

  • topic_name (str)
  • response (Optional['KxsResponse'])

Returns

  • TopicHandle

sapi_unregister_publisher()

Unregister an existing publisher.

Signature

sapi_unregister_publisher(topic_handle: TopicHandle, response: Optional['KxsResponse'] = None) -> bool
Parameters

  • topic_handle (TopicHandle)
  • response (Optional['KxsResponse'])

Returns

  • bool

publish()

Publish a message or data payload to a stream or queue.

Signature

publish(topic_handle: TopicHandle, req_corr: int, msg_type: int, payload: pykx.Dictionary, header: Optional[pykx.Dictionary] = None, retry_policy: Optional[SAPIRetryPolicy] = None, response: KxsResponse = None) -> bool
Parameters

  • topic_handle (TopicHandle)
  • req_corr (int)
  • msg_type (int)
  • payload (pykx.Dictionary)
  • header (Optional[pykx.Dictionary])
  • retry_policy (Optional[SAPIRetryPolicy])
  • response (KxsResponse)

Returns

  • bool

register_queue_listener()

Signature

register_queue_listener(handle: KxsHandle, queue: str, handler: QueueHandler, ack_mode: SAPIAckMode, workers: int, response: KxsResponse) -> bool
Parameters

  • handle (KxsHandle)
  • queue (str)
  • handler (QueueHandler)
  • ack_mode (SAPIAckMode)
  • workers (int)
  • response (KxsResponse)

Returns

  • bool

unregister_queue_listener()

Signature

unregister_queue_listener(handle: KxsHandle, queue: str, response: KxsResponse) -> bool
Parameters

  • handle (KxsHandle)
  • queue (str)
  • response (KxsResponse)

Returns

  • bool

ack_queue()

Signature

ack_queue(handle: KxsHandle, queue: str, queue_id: int) -> bool
Parameters

  • handle (KxsHandle)
  • queue (str)
  • queue_id (int)

Returns

  • bool

register_log_handler()

Register a custom log handler callback function.

Signature

register_log_handler(callback: LogHandler) -> None
Parameters

  • callback (LogHandler)

Returns

  • None

set_log_levels()

Signature

set_log_levels(trace_level: int, debug_level: int, info_level: int, warn_level: int, error_level: int, fatal_level: int) -> None
Parameters

  • trace_level (int)
  • debug_level (int)
  • info_level (int)
  • warn_level (int)
  • error_level (int)
  • fatal_level (int)

Returns

  • None

event_handler()

Return an object that provides access to SAPI events.

Signature

event_handler(handle: KxsHandle) -> SAPIEvents
Parameters

  • handle (KxsHandle)

Returns

  • SAPIEvents

get_tcp_endpoint()

Return the TCP endpoint string used for inbound RP connections.

Signature

get_tcp_endpoint(buf_len: int = 512) -> str
Parameters

  • buf_len (int), default: 512

Returns

  • str