API ReferenceΒΆ
The following is a API reference of Autobahn generated from Python source code and docstrings.
Warning
This is a complete reference of the public API of Autobahn. User code and applications should only rely on the public API, since internal APIs can (and will) change without any guarantees. Anything not listed here is considered a private API.
- Module
autobahn.utilEqualityMixinIdGeneratorObservableMixinStopwatchTrackerencode_truncate()generate_activation_code()generate_serial_number()generate_token()generate_user_password()id()machine_id()newid()parse_keyfile()public()rid()rtime()utcnow()utcstr()write_keyfile()xor()- EqualityMixin
- IdGenerator
- ObservableMixin
- Stopwatch
- Tracker
- encode_truncate
- generate_activation_code
- generate_serial_number
- generate_token
- generate_user_password
- id
- machine_id
- newid
- parse_keyfile
- public
- rid
- rtime
- utcnow
- utcstr
- write_keyfile
- xor
- Module
autobahn.websocket- WebSocket Interfaces
IWebSocketChannelIWebSocketChannel.onClose()IWebSocketChannel.onConnect()IWebSocketChannel.onConnecting()IWebSocketChannel.onMessage()IWebSocketChannel.onOpen()IWebSocketChannel.onPing()IWebSocketChannel.onPong()IWebSocketChannel.sendClose()IWebSocketChannel.sendMessage()IWebSocketChannel.sendPing()IWebSocketChannel.sendPong()
IWebSocketServerChannelFactoryIWebSocketClientChannelFactoryIWebSocketClientChannelFactory.resetProtocolOptions()IWebSocketClientChannelFactory.setProtocolOptions()IWebSocketClientChannelFactory.setSessionParameters()- onClose
- onConnect
- onConnecting
- onMessage
- onOpen
- onPing
- onPong
- sendClose
- sendMessage
- sendPing
- sendPong
- resetProtocolOptions
- setProtocolOptions
- setSessionParameters
- resetProtocolOptions
- setProtocolOptions
- setSessionParameters
- WebSocket Types
- WebSocket Compression
PerMessageBzip2PerMessageBzip2OfferPerMessageBzip2OfferAcceptPerMessageBzip2ResponsePerMessageBzip2ResponseAcceptPerMessageCompressPerMessageCompressOfferPerMessageCompressOfferAcceptPerMessageCompressResponsePerMessageCompressResponseAcceptPerMessageDeflatePerMessageDeflateOfferPerMessageDeflateOfferAcceptPerMessageDeflateResponsePerMessageDeflateResponseAcceptPerMessageSnappyPerMessageSnappyOfferPerMessageSnappyOfferAcceptPerMessageSnappyResponsePerMessageSnappyResponseAccept
- WebSocket Utilities
create_url()parse_url()- IWebSocketChannel
- IWebSocketServerChannelFactory
- IWebSocketClientChannelFactory
- ConnectingRequest
- ConnectionAccept
- ConnectionDeny
- ConnectionRequest
- ConnectionResponse
- IncomingMessage
- Message
- OutgoingMessage
- Ping
- PerMessageBzip2
- PerMessageBzip2Offer
- PerMessageBzip2OfferAccept
- PerMessageBzip2Response
- PerMessageBzip2ResponseAccept
- PerMessageCompress
- PerMessageCompressOffer
- PerMessageCompressOfferAccept
- PerMessageCompressResponse
- PerMessageCompressResponseAccept
- PerMessageDeflate
- PerMessageDeflateOffer
- PerMessageDeflateOfferAccept
- PerMessageDeflateResponse
- PerMessageDeflateResponseAccept
- PerMessageSnappy
- PerMessageSnappyOffer
- PerMessageSnappyOfferAccept
- PerMessageSnappyResponse
- PerMessageSnappyResponseAccept
- create_url
- parse_url
- WebSocket Interfaces
- Module
autobahn.rawsocket - Module
autobahn.wamp- WAMP Interfaces
IAuthenticatorICryptosignKeyIEthereumKeyIKeyIMessageIObjectSerializerIPayloadCodecISecurityModuleISecurityModule.can_lockISecurityModule.close()ISecurityModule.create_key()ISecurityModule.delete_key()ISecurityModule.get_counter()ISecurityModule.get_random()ISecurityModule.increment_counter()ISecurityModule.is_lockedISecurityModule.is_openISecurityModule.lock()ISecurityModule.open()ISecurityModule.unlock()
ISerializerISessionISession.call()ISession.configISession.define()ISession.disconnect()ISession.get_payload_codec()ISession.is_attached()ISession.is_connected()ISession.join()ISession.leave()ISession.onChallenge()ISession.onConnect()ISession.onDisconnect()ISession.onJoin()ISession.onLeave()ISession.onUserError()ISession.onWelcome()ISession.publish()ISession.register()ISession.session_detailsISession.set_payload_codec()ISession.subscribe()ISession.transport
ITransportITransportHandlerITransportHandler.onClose()ITransportHandler.onMessage()ITransportHandler.onOpen()- on_challenge
- on_welcome
- sign_challenge
- verify_challenge
- address
- sign_typed_data
- verify_typed_data
- can_sign
- key_no
- key_type
- public_key
- recover
- security_module
- sign
- MESSAGE_TYPE
- parse
- serialize
- uncache
- BINARY
- NAME
- serialize
- unserialize
- decode
- encode
- can_lock
- close
- create_key
- delete_key
- get_counter
- get_random
- increment_counter
- is_locked
- is_open
- lock
- open
- unlock
- MESSAGE_TYPE_MAP
- MIME_TYPE
- RAWSOCKET_SERIALIZER_ID
- SERIALIZER_ID
- serialize
- unserialize
- call
- config
- define
- disconnect
- get_payload_codec
- is_attached
- is_connected
- join
- leave
- onChallenge
- onConnect
- onDisconnect
- onJoin
- onLeave
- onUserError
- onWelcome
- publish
- register
- session_details
- set_payload_codec
- subscribe
- transport
- abort
- close
- isOpen
- send
- transport_details
- onClose
- onMessage
- onOpen
- WAMP Types
AcceptCallDetailsCallOptionsCallResultChallengeCloseDetailsComponentConfigDenyEncodedPayloadEventDetailsHelloDetailsHelloReturnPublicationPublishOptionsRegisterOptionsRegistrationSessionDetailsSessionDetails.authextraSessionDetails.authidSessionDetails.authmethodSessionDetails.authproviderSessionDetails.authroleSessionDetails.marshal()SessionDetails.parse()SessionDetails.realmSessionDetails.resumableSessionDetails.resume_tokenSessionDetails.resumedSessionDetails.serializerSessionDetails.sessionSessionDetails.transport
SessionIdentSubscribeOptionsSubscriptionTransportDetailsTransportDetails.channel_framingTransportDetails.channel_idTransportDetails.channel_serializerTransportDetails.channel_typeTransportDetails.channel_typeidTransportDetails.http_cbtidTransportDetails.http_headers_receivedTransportDetails.http_headers_sentTransportDetails.is_secureTransportDetails.is_serverTransportDetails.ownTransportDetails.own_fdTransportDetails.own_pidTransportDetails.own_tidTransportDetails.peerTransportDetails.peer_certTransportDetails.websocket_extensions_in_useTransportDetails.websocket_protocol
CallRequestEndpointHandlerInvocationRequestPublicationPublishRequestRegisterRequestRegistrationSubscribeRequestSubscriptionUnregisterRequestUnsubscribeRequest- message_attr
- message_attr
- message_attr
- unregister
- authextra
- authid
- authmethod
- authprovider
- authrole
- marshal
- parse
- realm
- resumable
- resume_token
- resumed
- serializer
- session
- transport
- from_calldetails
- from_eventdetails
- message_attr
- unsubscribe
- channel_framing
- channel_id
- channel_serializer
- channel_type
- channel_typeid
- http_cbtid
- http_headers_received
- http_headers_sent
- is_secure
- is_server
- own
- own_fd
- own_pid
- own_tid
- peer
- peer_cert
- websocket_extensions_in_use
- websocket_protocol
- unregister
- unsubscribe
- WAMP Exceptions
ApplicationErrorApplicationError.AUTHENTICATION_FAILEDApplicationError.AUTHORIZATION_FAILEDApplicationError.CANCELEDApplicationError.CLOSE_REALMApplicationError.ENC_DECRYPT_ERRORApplicationError.ENC_NO_PAYLOAD_CODECApplicationError.ENC_TRUSTED_URI_MISMATCHApplicationError.GOODBYE_AND_OUTApplicationError.INVALID_ARGUMENTApplicationError.INVALID_PAYLOADApplicationError.INVALID_URIApplicationError.NOT_AUTHORIZEDApplicationError.NO_AUTH_METHODApplicationError.NO_ELIGIBLE_CALLEEApplicationError.NO_SUCH_PRINCIPALApplicationError.NO_SUCH_PROCEDUREApplicationError.NO_SUCH_REALMApplicationError.NO_SUCH_REGISTRATIONApplicationError.NO_SUCH_ROLEApplicationError.NO_SUCH_SESSIONApplicationError.NO_SUCH_SUBSCRIPTIONApplicationError.PAYLOAD_SIZE_EXCEEDEDApplicationError.PROCEDURE_ALREADY_EXISTSApplicationError.PROCEDURE_EXISTS_INVOCATION_POLICY_CONFLICTApplicationError.SYSTEM_SHUTDOWNApplicationError.TIMEOUTApplicationError.TYPE_CHECK_ERRORApplicationError.error_message()
ErrorInvalidPayloadInvalidUriInvalidUriErrorNotAuthorizedProtocolErrorSerializationErrorSessionNotReadyTransportLostTypeCheckError- AUTHENTICATION_FAILED
- AUTHORIZATION_FAILED
- CANCELED
- CLOSE_REALM
- ENC_DECRYPT_ERROR
- ENC_NO_PAYLOAD_CODEC
- ENC_TRUSTED_URI_MISMATCH
- GOODBYE_AND_OUT
- INVALID_ARGUMENT
- INVALID_PAYLOAD
- INVALID_URI
- NOT_AUTHORIZED
- NO_AUTH_METHOD
- NO_ELIGIBLE_CALLEE
- NO_SUCH_PRINCIPAL
- NO_SUCH_PROCEDURE
- NO_SUCH_REALM
- NO_SUCH_REGISTRATION
- NO_SUCH_ROLE
- NO_SUCH_SESSION
- NO_SUCH_SUBSCRIPTION
- PAYLOAD_SIZE_EXCEEDED
- PROCEDURE_ALREADY_EXISTS
- PROCEDURE_EXISTS_INVOCATION_POLICY_CONFLICT
- SYSTEM_SHUTDOWN
- TIMEOUT
- TYPE_CHECK_ERROR
- error_message
- WAMP Authentication and Encryption
AuthScramcheck_totp()compute_totp()compute_wcs()create_authenticator()derive_key()derive_scram_credential()generate_totp_secret()generate_wcs()pbkdf2()CryptosignAuthextraCryptosignKeyCryptosignKey.can_signCryptosignKey.commentCryptosignKey.from_file()CryptosignKey.from_keyfile()CryptosignKey.from_seedphrase()CryptosignKey.from_ssh_bytes()CryptosignKey.from_ssh_file()CryptosignKey.key_noCryptosignKey.key_typeCryptosignKey.public_key()CryptosignKey.security_moduleCryptosignKey.sign()CryptosignKey.sign_challenge()
EncodedPayloadKeyKeyRingKeyRing.decode()KeyRing.encode()KeyRing.generate_key()KeyRing.generate_key_hex()KeyRing.set_key()- on_welcome
- can_sign
- comment
- from_file
- from_keyfile
- from_seedphrase
- from_ssh_bytes
- from_ssh_file
- key_no
- key_type
- public_key
- security_module
- sign
- sign_challenge
- decode
- encode
- generate_key
- generate_key_hex
- set_key
- WAMP Serializer
CBORObjectSerializerCBORSerializerFlatBuffersSerializerJsonSerializerMsgPackSerializerSerializerUBJSONSerializerUBJSONSerializer.MIME_TYPEUBJSONSerializer.RAWSOCKET_SERIALIZER_IDUBJSONSerializer.SERIALIZER_ID- BINARY
- serialize
- unserialize
- MIME_TYPE
- RAWSOCKET_SERIALIZER_ID
- SERIALIZER_ID
- MIME_TYPE
- RAWSOCKET_SERIALIZER_ID
- SERIALIZER_ID
- MIME_TYPE
- RAWSOCKET_SERIALIZER_ID
- SERIALIZER_ID
- MIME_TYPE
- RAWSOCKET_SERIALIZER_ID
- SERIALIZER_ID
- MESSAGE_TYPE_MAP
- RATED_MESSAGE_SIZE
- serialize
- set_stats_autoreset
- stats
- stats_bytes
- stats_messages
- stats_rated_messages
- stats_reset
- unserialize
- MIME_TYPE
- RAWSOCKET_SERIALIZER_ID
- SERIALIZER_ID
- WAMP Messages
AbortAuthenticateCallCancelChallengeErrorEventGoodbyeHelloInterruptInvocationMessagePublishPublishedRegisterRegisteredResultSubscribeSubscribedUnregisterUnregisteredUnsubscribeUnsubscribedWelcomeYieldcheck_or_raise_extra()check_or_raise_id()check_or_raise_realm_name()check_or_raise_uri()identify_realm_name_category()is_valid_enc_algo()is_valid_enc_serializer()- IAuthenticator
- ICryptosignKey
- IEthereumKey
- IKey
- IMessage
- IObjectSerializer
- IPayloadCodec
- ISecurityModule
- ISerializer
- ISession
- ITransport
- ITransportHandler
- Accept
- CallDetails
- CallOptions
- CallResult
- Challenge
- CloseDetails
- ComponentConfig
- Deny
- EncodedPayload
- EventDetails
- HelloDetails
- HelloReturn
- Publication
- PublishOptions
- RegisterOptions
- Registration
- SessionDetails
- SessionIdent
- SubscribeOptions
- Subscription
- TransportDetails
- CallRequest
- Endpoint
- Handler
- InvocationRequest
- Publication
- PublishRequest
- RegisterRequest
- Registration
- SubscribeRequest
- Subscription
- UnregisterRequest
- UnsubscribeRequest
- ApplicationError
- Error
- InvalidPayload
- InvalidUri
- InvalidUriError
- NotAuthorized
- ProtocolError
- SerializationError
- SessionNotReady
- TransportLost
- TypeCheckError
- AuthScram
- check_totp
- compute_totp
- compute_wcs
- create_authenticator
- derive_key
- derive_scram_credential
- generate_totp_secret
- generate_wcs
- pbkdf2
- CryptosignAuthextra
- CryptosignKey
- EncodedPayload
- Key
- KeyRing
- CBORObjectSerializer
- CBORSerializer
- FlatBuffersSerializer
- JsonSerializer
- MsgPackSerializer
- Serializer
- UBJSONSerializer
- Abort
- Authenticate
- Call
- Cancel
- Challenge
- Error
- Event
- Goodbye
- Hello
- Interrupt
- Invocation
- Message
- Publish
- Published
- Register
- Registered
- Result
- Subscribe
- Subscribed
- Unregister
- Unregistered
- Unsubscribe
- Unsubscribed
- Welcome
- Yield
- check_or_raise_extra
- check_or_raise_id
- check_or_raise_realm_name
- check_or_raise_uri
- identify_realm_name_category
- is_valid_enc_algo
- is_valid_enc_serializer
- WAMP Interfaces
- Module
autobahn.wamp.component - Module
autobahn.twisted- Component
- WebSocket Protocols and Factories
- WAMP-over-WebSocket Protocols and Factories
- WAMP-over-RawSocket Protocols and Factories
- WAMP Sessions
ApplicationSessionApplicationRunner- Component
- run
- WebSocketServerProtocol
- WebSocketClientProtocol
- WebSocketServerFactory
- WebSocketClientFactory
- WampWebSocketServerProtocol
- WampWebSocketClientProtocol
- WampWebSocketServerFactory
- WampWebSocketClientFactory
- WampRawSocketServerProtocol
- WampRawSocketClientProtocol
- WampRawSocketServerFactory
- WampRawSocketClientFactory
- ApplicationSession
- ApplicationRunner
- Module
autobahn.asyncio- Component
- WebSocket Protocols and Factories
- WAMP-over-WebSocket Protocols and Factories
- WAMP-over-RawSocket Protocols and Factories
- WAMP Sessions
ApplicationSessionApplicationRunner- Component
- run
- WebSocketServerProtocol
- WebSocketClientProtocol
- WebSocketServerFactory
- WebSocketClientFactory
- WampWebSocketServerProtocol
- WampWebSocketClientProtocol
- WampWebSocketServerFactory
- WampWebSocketClientFactory
- WampRawSocketServerProtocol
- WampRawSocketClientProtocol
- WampRawSocketServerFactory
- WampRawSocketClientFactory
- ApplicationSession
- ApplicationRunner
- Module
autobahn.xbrActorTypeChannelTypeEthereumKeyEthereumKey.address()EthereumKey.can_signEthereumKey.from_address()EthereumKey.from_bytes()EthereumKey.from_keyfile()EthereumKey.from_seedphrase()EthereumKey.key_noEthereumKey.key_typeEthereumKey.public_key()EthereumKey.recover()EthereumKey.security_moduleEthereumKey.sign()EthereumKey.sign_typed_data()EthereumKey.verify_typed_data()
FbsEnumFbsRepositoryFbsSchemaFbsTypeFederatedRealmIBuyerIConsumerIDelegateIMarketMakerIProviderISellerKeySeriesMemberLevelNodeTypeProfileSecurityModuleMemorySecurityModuleMemory.can_lockSecurityModuleMemory.close()SecurityModuleMemory.from_config()SecurityModuleMemory.from_keyfile()SecurityModuleMemory.from_seedphrase()SecurityModuleMemory.get_counter()SecurityModuleMemory.get_random()SecurityModuleMemory.increment_counter()SecurityModuleMemory.is_lockedSecurityModuleMemory.is_openSecurityModuleMemory.lock()SecurityModuleMemory.open()SecurityModuleMemory.unlock()
SeederSimpleBlockchainSimpleBlockchain.get_actor_status()SimpleBlockchain.get_balances()SimpleBlockchain.get_channel_status()SimpleBlockchain.get_contract_adrs()SimpleBlockchain.get_delegate_status()SimpleBlockchain.get_domain_status()SimpleBlockchain.get_market_status()SimpleBlockchain.get_member_status()SimpleBlockchain.get_node_status()SimpleBlockchain.start()SimpleBlockchain.stop()
SimpleBuyerUserConfigaccount_from_seedphrase()check_seedphrase()create_eip712_authority_certificate()create_eip712_delegate_certificate()expand_argon2_secret()generate_seedphrase()is_address()is_block_number()is_bytes16()is_chain_id()is_cs_pubkey()is_eth_privkey()is_signature()make_w3()parse_certificate_chain()pkm_from_argon2_secret()recover_eip712_api_publish()recover_eip712_authority_certificate()recover_eip712_catalog_create()recover_eip712_channel_close()recover_eip712_channel_open()recover_eip712_consent()recover_eip712_delegate_certificate()recover_eip712_market_create()recover_eip712_market_join()recover_eip712_member_login()recover_eip712_member_register()setProvider()sign_eip712_api_publish()sign_eip712_authority_certificate()sign_eip712_catalog_create()sign_eip712_channel_close()sign_eip712_channel_open()sign_eip712_consent()sign_eip712_delegate_certificate()sign_eip712_market_create()sign_eip712_market_join()sign_eip712_member_login()sign_eip712_member_register()stretch_argon2_secret()xbrcatalogxbrchannelxbrmarketxbrnetworkxbrtoken- ActorType
- ChannelType
- EthereumKey
- FbsEnum
- FbsRepository
- FbsSchema
- FbsType
- FederatedRealm
- IBuyer
- IConsumer
- IDelegate
- IMarketMaker
- IProvider
- ISeller
- KeySeries
- MemberLevel
- NodeType
- Profile
- SecurityModuleMemory
- Seeder
- SimpleBlockchain
- SimpleBuyer
- UserConfig
- account_from_seedphrase
- check_seedphrase
- create_eip712_authority_certificate
- create_eip712_delegate_certificate
- expand_argon2_secret
- generate_seedphrase
- is_address
- is_block_number
- is_bytes16
- is_chain_id
- is_cs_pubkey
- is_eth_privkey
- is_signature
- make_w3
- parse_certificate_chain
- pkm_from_argon2_secret
- recover_eip712_api_publish
- recover_eip712_authority_certificate
- recover_eip712_catalog_create
- recover_eip712_channel_close
- recover_eip712_channel_open
- recover_eip712_consent
- recover_eip712_delegate_certificate
- recover_eip712_market_create
- recover_eip712_market_join
- recover_eip712_member_login
- recover_eip712_member_register
- setProvider
- sign_eip712_api_publish
- sign_eip712_authority_certificate
- sign_eip712_catalog_create
- sign_eip712_channel_close
- sign_eip712_channel_open
- sign_eip712_consent
- sign_eip712_delegate_certificate
- sign_eip712_market_create
- sign_eip712_market_join
- sign_eip712_member_login
- sign_eip712_member_register
- stretch_argon2_secret
- xbrcatalog
- xbrchannel
- xbrmarket
- xbrnetwork
- xbrtoken