aries_cloudagent.transport.inbound package¶
Subpackages¶
Submodules¶
aries_cloudagent.transport.inbound.base module¶
Base inbound transport class.
-
class
aries_cloudagent.transport.inbound.base.
BaseInboundTransport
[source]¶ Bases:
abc.ABC
Base inbound transport class.
-
class
aries_cloudagent.transport.inbound.base.
InboundTransportConfiguration
(module, host, port)¶ Bases:
tuple
-
host
¶ Alias for field number 1
-
module
¶ Alias for field number 0
-
port
¶ Alias for field number 2
-
-
exception
aries_cloudagent.transport.inbound.base.
InboundTransportRegistrationError
(*args, error_code: str = None, **kwargs)[source]¶ Bases:
aries_cloudagent.error.BaseError
Error in loading an inbound transport.
-
exception
aries_cloudagent.transport.inbound.base.
InboundTransportSetupError
(*args, error_code: str = None, **kwargs)[source]¶ Bases:
aries_cloudagent.error.BaseError
Setup error for an inbound transport.
aries_cloudagent.transport.inbound.http module¶
Http Transport classes and functions.
-
class
aries_cloudagent.transport.inbound.http.
HttpTransport
(host: str, port: int, message_router: Coroutine[T_co, T_contra, V_co], register_socket: Coroutine[T_co, T_contra, V_co])[source]¶ Bases:
aries_cloudagent.transport.inbound.base.BaseInboundTransport
Http Transport class.
-
inbound_message_handler
(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fd661c4be10>)[source]¶ Message handler for inbound messages.
Parameters: request – aiohttp request object Returns: The web response
-
invite_message_handler
(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7fd661c4be10>)[source]¶ Message handler for invites.
Parameters: request – aiohttp request object Returns: The web response
-
make_application
() → <sphinx.ext.autodoc.importer._MockObject object at 0x7fd661c4be10>[source]¶ Construct the aiohttp application.
-
scheme
¶ Accessor for this transport’s scheme.
-
aries_cloudagent.transport.inbound.manager module¶
Inbound transport manager.
-
class
aries_cloudagent.transport.inbound.manager.
InboundTransportManager
[source]¶ Bases:
object
Inbound transport manager class.
-
register
(config: aries_cloudagent.transport.inbound.base.InboundTransportConfiguration, message_handler, register_socket)[source]¶ Register transport module.
Parameters: - module_path – Path to module
- host – The host to register on
- port – The port to register on
- message_handler – The message handler for incoming messages
- register_socket – A coroutine for registering a new socket
-
aries_cloudagent.transport.inbound.ws module¶
Websockets Transport classes and functions.
-
class
aries_cloudagent.transport.inbound.ws.
WsTransport
(host: str, port: int, message_router: Coroutine[T_co, T_contra, V_co], register_socket: Coroutine[T_co, T_contra, V_co])[source]¶ Bases:
aries_cloudagent.transport.inbound.base.BaseInboundTransport
Websockets Transport class.
-
inbound_message_handler
(request)[source]¶ Message handler for inbound messages.
Parameters: request – aiohttp request object Returns: The web response
-
make_application
() → <sphinx.ext.autodoc.importer._MockObject object at 0x7fd6612a6828>[source]¶ Construct the aiohttp application.
-
scheme
¶ Accessor for this transport’s scheme.
-