OUCH API Reference

Ouch

class nasdaq_protocols.ouch.Message(record=None)

Bases: SoupAppMessage

MsgIdClass

alias of SoupAppMessageId

class nasdaq_protocols.ouch.OuchSessionId(soup_session_id=None, protocol_name='ouch')

Bases: SoupAppSessionId

Parameters:
class nasdaq_protocols.ouch.ClientSession(soup_session, on_msg_coro=None, on_close_coro=None, closed=False, session_id=None, close_event=None, message_queue=None)

Bases: SoupAppClientSession

Parameters:

  • soup_session (SoupClientSession)

  • on_msg_coro (Callable[[Type[M]], Awaitable[None]])

  • on_close_coro (Callable[[], Awaitable[None]])

  • closed (bool)

  • session_id (SoupAppSessionId)

  • close_event (Event)

  • message_queue (DispatchableMessageQueue)

decode(bytes_)

Decode the given bytes into an ouch message.

Parameters:

bytes_ (bytes)

async nasdaq_protocols.ouch.connect_async(remote, user, passwd, session_id, sequence=0, session_factory=None, on_msg_coro=None, on_close_coro=None, client_heartbeat_interval=10, server_heartbeat_interval=10, connect_timeout=5)

Connect to the OUCH server.

Parameters:

  • remote (tuple[str, int]) – tuple of host and port

  • user (str) – Username to login

  • passwd (str) – Password to login

  • session_id – Name of the session to join [Default=’’] .

  • sequence (int) – The sequence number. [Default=1]

  • session_factory (Callable[[SoupClientSession], ClientSession]) – Factory to create a SoupClientSession.

  • on_msg_coro (Callable[[Type[Message]], Awaitable[None]]) – callback, message from server.

  • on_close_coro (Callable[[], Awaitable[None]]) – callback, connection closed .

  • client_heartbeat_interval (int) – seconds between client heartbeats.

  • server_heartbeat_interval (int) – seconds between server heartbeats.

  • connect_timeout (int) – seconds to wait for connection.

Returns:

SoupClientSession

Ouch Session

class nasdaq_protocols.ouch.session.OuchSessionId(soup_session_id=None, protocol_name='ouch')

Bases: SoupAppSessionId

Parameters:
class nasdaq_protocols.ouch.session.ClientSession(soup_session, on_msg_coro=None, on_close_coro=None, closed=False, session_id=None, close_event=None, message_queue=None)

Bases: SoupAppClientSession

Parameters:

  • soup_session (SoupClientSession)

  • on_msg_coro (Callable[[Type[M]], Awaitable[None]])

  • on_close_coro (Callable[[], Awaitable[None]])

  • closed (bool)

  • session_id (SoupAppSessionId)

  • close_event (Event)

  • message_queue (DispatchableMessageQueue)

decode(bytes_)

Decode the given bytes into an ouch message.

Parameters:

bytes_ (bytes)

Ouch Messages

class nasdaq_protocols.ouch.core.Message(record=None)

Bases: SoupAppMessage

MsgIdClass

alias of SoupAppMessageId