openwpm.socket_interface module

class openwpm.socket_interface.ClientSocket(serialization='json', verbose=False)

Bases: object

A client socket for sending messages

close()

connect(host, port)

send(msg)

Sends an arbitrary python object to the connected socket. Serializes using dill if not string, and prepends msg len (4-bytes) and serialization type (1-byte).

class openwpm.socket_interface.ServerSocket(name=None, verbose=False)

Bases: object

A server socket to receive and process string messages from client sockets to a central queue

close()

receive_msg(client, msglen)

start_accepting()

Start the listener thread

async openwpm.socket_interface.get_message_from_reader(reader: StreamReader) → Any

Reads a message from the StreamReader To safely use this method, you should guard against the exception like this:

try:
    record: Tuple[str, Any] = await get_message_from_reader(reader)
except IncompleteReadError as e:
    print("The underlying socket closed", repr(e))

Raises:

IncompleteReadError: If the underlying socket is closed

openwpm.socket_interface.main()