fiftyone.service.ipc.IPCServer

class documentation

class IPCServer(socketserver.TCPServer): (source)

Constructor: IPCServer(on_message)

View In Hierarchy

Server that listens for inter-process messages.

Messages are exchanged as pickle-encoded objects.

Class Method run_in_background Convenience wrapper that creates a new server instance and calls serve_forever in a background thread.
Method __enter__ Undocumented
Method __exit__ Undocumented
Method __init__ Constructs (but does not start) a server.
Method serve_forever Handles one request at a time until the server shuts down.
Method stop Stops and shuts down the server.
Class Variable timeout Undocumented
Instance Variable on_message Undocumented
Property port Undocumented
Instance Variable __in_serve_forever Undocumented
Instance Variable __lock Undocumented
@classmethod
def run_in_background(cls, on_message): (source)

Convenience wrapper that creates a new server instance and calls serve_forever in a background thread.

The server will be listening before this function returns.

Returns
the IPCServer instance
def __enter__(self): (source)

Undocumented

def __exit__(self, *args): (source)

Undocumented

def __init__(self, on_message): (source)

Constructs (but does not start) a server.

Parameters
on_message:functioncallback that takes a single argument (any Python object sent by a client) and returns an object in response
def serve_forever(self): (source)

Handles one request at a time until the server shuts down.

This is a simple wrapper around TCPServer.serve_forever that keeps track of whether it was called.

def stop(self): (source)

Stops and shuts down the server.

Interrupts serve_forever() if necessary.

timeout: int = (source)

Undocumented

on_message = (source)

Undocumented

@property
port = (source)

Undocumented

__in_serve_forever: bool = (source)

Undocumented

__lock = (source)

Undocumented