Pyro4 library API

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

• Pyro4 — Main API package
  • config
  • current_context
  • URI
  • Proxy
  • Daemon
  • Future
  • callback()
  • batch()
  • asyncproxy()
  • locateNS()
  • resolve()
  • expose()
  • oneway()
  • behavior()
• Pyro4.core — core Pyro logic
  • Daemon
    • Daemon.annotations()
    • Daemon.clientDisconnect()
    • Daemon.close()
    • Daemon.combine()
    • Daemon.events()
    • Daemon.handleRequest()
    • Daemon.housekeeping()
    • Daemon.locationStr
    • Daemon.natLocationStr
    • Daemon.objectsById
    • 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._pyroBatch()
    • Proxy._pyroAsync()
    • Proxy._pyroAnnotations()
    • Proxy._pyroResponseAnnotations()
    • Proxy._pyroValidateHandshake()
    • Proxy._pyroTimeout
    • Proxy._pyroHmacKey
    • Proxy._pyroMaxRetries
    • Proxy._pyroSerializer
    • Proxy._pyroHandshake
  • SerializedBlob
    • SerializedBlob.deserialized()
  • URI
    • URI.asString()
    • URI.isUnixsockLocation()
    • URI.location
  • _StreamResultIterator
  • asyncproxy()
  • batch()
  • behavior()
  • callback()
  • current_context
  • expose()
  • oneway()
• Pyro4.naming — Pyro name server
  • locateNS()
  • resolve()
  • startNS()
  • startNSloop()
  • type_meta()
  • NameServer
    • NameServer.count()
    • NameServer.list()
    • NameServer.lookup()
    • NameServer.ping()
    • NameServer.register()
    • NameServer.remove()
    • NameServer.set_metadata()
  • DbmStorage
    • DbmStorage.clear()
  • SqlStorage
    • SqlStorage.clear()
• Pyro4.util — Utilities and serializers
  • CloudpickleSerializer
  • DillSerializer
  • JsonSerializer
  • MarshalSerializer
    • MarshalSerializer.class_to_dict()
  • MsgpackSerializer
  • PickleSerializer
  • SerializerBase
    • SerializerBase.class_to_dict()
    • SerializerBase.deserializeCall()
    • SerializerBase.deserializeData()
    • SerializerBase.dict_to_class()
    • SerializerBase.register_class_to_dict()
    • SerializerBase.register_dict_to_class()
    • SerializerBase.serializeCall()
    • SerializerBase.serializeData()
    • SerializerBase.unregister_class_to_dict()
    • SerializerBase.unregister_dict_to_class()
  • SerpentSerializer
    • SerpentSerializer.dict_to_class()
  • excepthook()
  • fixIronPythonExceptionForPickle()
  • formatTraceback()
  • getAttribute()
  • getPyroTraceback()
  • get_exposed_members()
  • get_exposed_property_value()
  • is_private_attribute()
  • reset_exposed_members()
  • set_exposed_property_value()
• Pyro4.socketutil — Socket related utilities
  • SocketConnection
  • bindOnUnusedPort()
  • createBroadcastSocket()
  • createSocket()
  • findProbablyUnusedPort()
  • getInterfaceAddress()
  • getIpAddress()
  • getIpVersion()
  • getSSLcontext()
  • interruptSocket()
  • receiveData()
  • sendData()
  • setKeepalive()
  • setNoDelay()
  • setNoInherit()
  • setReuseAddr()
• Pyro4.message — Pyro wire protocol message
  • Message
    • Message.decompress_if_needed()
    • Message.from_header()
    • Message.hmac()
    • Message.ping()
    • Message.recv()
    • Message.send()
    • Message.to_bytes()
  • secure_compare()
• Pyro4.constants — Constant value definitions
  • VERSION
  • DAEMON_NAME
  • NAMESERVER_NAME
  • FLAME_NAME
  • PROTOCOL_VERSION
• Pyro4.config — Configuration items
• Pyro4.errors — Exception classes
  • CommunicationError
  • ConnectionClosedError
  • DaemonError
  • MessageTooLargeError
  • NamingError
  • ProtocolError
  • PyroError
  • SecurityError
  • SerializeError
  • TimeoutError
• Pyro4.test.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()
• Pyro4.utils.flame — Foreign Location Automatic Module Exposer
  • Flame
    • Flame.builtin()
    • Flame.console()
    • Flame.evaluate()
    • Flame.execute()
    • Flame.getfile()
    • Flame.getmodule()
    • Flame.module()
    • Flame.sendfile()
    • Flame.sendmodule()
  • connect()
  • createModule()
  • start()
• Pyro4.futures — asynchronous calls
  • Future
    • Future.cancel()
    • Future.delay()
    • Future.iferror()
    • Future.then()
  • FutureResult
    • FutureResult.iferror()
    • FutureResult.ready
    • FutureResult.then()
    • FutureResult.value
    • FutureResult.wait()
• 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