Pyro5 library API

This chapter describes Pyro’s library API. All Pyro classes and functions are defined in sub packages such as Pyro5.core, but for ease of use, the most important ones are also placed in the Pyro5.api package.

• Pyro5.api — Main API package
  • BatchProxy
  • Daemon
    • Daemon.annotations()
    • Daemon.clientDisconnect()
    • Daemon.close()
    • Daemon.combine()
    • Daemon.events()
    • Daemon.handleRequest()
    • Daemon.housekeeping()
    • Daemon.locationStr
    • Daemon.proxyFor()
    • Daemon.register()
    • Daemon.requestLoop()
    • Daemon.resetMetadataCache()
    • Daemon.selector
    • Daemon.serveSimple()
    • Daemon.shutdown()
    • Daemon.sock
    • Daemon.sockets
    • Daemon.unregister()
    • Daemon.uriFor()
    • Daemon.validateHandshake()
  • DaemonObject
    • DaemonObject.get_metadata()
    • DaemonObject.info()
    • DaemonObject.ping()
    • DaemonObject.registered()
  • Proxy
    • Proxy._pyroBind()
    • Proxy._pyroRelease()
    • Proxy._pyroReconnect()
    • Proxy._pyroValidateHandshake()
    • Proxy._pyroTimeout
    • Proxy._pyroMaxRetries
    • Proxy._pyroSerializer
    • Proxy._pyroHandshake
    • Proxy._pyroLocalSocket
  • SerializedBlob
    • SerializedBlob.deserialized()
  • SerializerBase
    • SerializerBase.class_to_dict()
    • SerializerBase.dict_to_class()
    • SerializerBase.register_class_to_dict()
    • SerializerBase.register_dict_to_class()
    • SerializerBase.unregister_class_to_dict()
    • SerializerBase.unregister_dict_to_class()
  • URI
    • URI.isUnixsockLocation()
    • URI.location
  • behavior()
  • callback()
  • expose()
  • locate_ns()
  • oneway()
  • register_class_to_dict()
  • register_dict_to_class()
  • resolve()
  • serve()
  • start_ns()
  • start_ns_loop()
  • type_meta()
  • unregister_class_to_dict()
  • unregister_dict_to_class()
• Pyro5.config — Configuration items
• Pyro5.client — Client code logic
  • BatchProxy
  • Proxy
    • Proxy._pyroBind()
    • Proxy._pyroRelease()
    • Proxy._pyroReconnect()
    • Proxy._pyroValidateHandshake()
    • Proxy._pyroTimeout
    • Proxy._pyroMaxRetries
    • Proxy._pyroSerializer
    • Proxy._pyroHandshake
    • Proxy._pyroLocalSocket
  • SerializedBlob
    • SerializedBlob.deserialized()
• Pyro5.core — core Pyro logic
  • URI
    • URI.isUnixsockLocation()
    • URI.location
  • locate_ns()
  • resolve()
  • type_meta()
• Pyro5.server — Server (daemon) logic
  • Daemon
    • Daemon.annotations()
    • Daemon.clientDisconnect()
    • Daemon.close()
    • Daemon.combine()
    • Daemon.events()
    • Daemon.handleRequest()
    • Daemon.housekeeping()
    • Daemon.locationStr
    • Daemon.proxyFor()
    • Daemon.register()
    • Daemon.requestLoop()
    • Daemon.resetMetadataCache()
    • Daemon.selector
    • Daemon.serveSimple()
    • Daemon.shutdown()
    • Daemon.sock
    • Daemon.sockets
    • Daemon.unregister()
    • Daemon.uriFor()
    • Daemon.validateHandshake()
  • DaemonObject
    • DaemonObject.get_metadata()
    • DaemonObject.info()
    • DaemonObject.ping()
    • DaemonObject.registered()
  • behavior()
  • callback()
  • expose()
  • oneway()
  • serve()
• Pyro5.errors — Exception classes
  • CommunicationError
  • ConnectionClosedError
  • DaemonError
  • MessageTooLargeError
  • NamingError
  • ProtocolError
  • PyroError
  • SecurityError
  • SerializeError
  • TimeoutError
  • excepthook()
  • format_traceback()
  • get_pyro_traceback()
• Pyro5.nameserver — Pyro name server
  • start_ns()
  • start_ns_loop()
  • NameServer
    • NameServer.count()
    • NameServer.list()
    • NameServer.lookup()
    • NameServer.ping()
    • NameServer.register()
    • NameServer.remove()
    • NameServer.set_metadata()
    • NameServer.yplookup()
• Pyro5.callcontext — Call context handling
  • current_context
• Pyro5.protocol — Pyro wire protocol
  • ReceivingMessage
    • ReceivingMessage.add_payload()
    • ReceivingMessage.validate()
  • SendingMessage
    • SendingMessage.ping()
  • log_wiredata()
  • recv_stub()
• Pyro5.socketutil — Socket related utilities
  • SocketConnection
  • bind_unused_port()
  • create_bc_socket()
  • create_socket()
  • find_probably_unused_port()
  • get_interface()
  • get_ip_address()
  • get_ssl_context()
  • interrupt_socket()
  • receive_data()
  • send_data()
  • set_keepalive()
  • set_nodelay()
  • set_noinherit()
  • set_reuseaddr()
• Pyro5.compatibility.Pyro4 — Pyro4 backward compatibility layer
  • Daemon
  • Proxy
  • URI
  • behavior()
  • callback()
  • expose()
  • oneway()
• Pyro5.utils.echoserver — Built-in echo server for testing purposes
  • EchoServer
    • EchoServer.echo()
    • EchoServer.error()
    • EchoServer.error_with_text()
    • EchoServer.generator()
    • EchoServer.oneway_echo()
    • EchoServer.oneway_slow()
    • EchoServer.shutdown()
    • EchoServer.slow()
• Pyro5.utils.httpgateway — HTTP to Pyro gateway
  • pyro_app()
• Socket server API contract
  • SocketServer_API
    • SocketServer_API.init()
    • SocketServer_API.loop()
    • SocketServer_API.events()
    • SocketServer_API.shutdown()
    • SocketServer_API.close()
    • SocketServer_API.wakeup()
    • SocketServer_API.sockets
    • SocketServer_API.sock
    • SocketServer_API.locationStr