socketClient

class birdseyelib.Client(ip, port)[source]

A socket client used to communicate with the external tool located at a set port and address.

Use the external tool to get and set the port and address the server should listen in to.

Parameters:

  • ip (str) – The socket address.

  • port (int) – The socket port number.

advance_frame()[source]

(Blocking) Sends all queued requests to the external tool and parses received responses. This will subsequently advance the emulator to the next frame.

Precondition:

client is connected to a socket.

close()[source]

Close socket connection with external tool and send a final message notifying the external tool before closing.

connect()[source]

(Blocking) Attempt to connect to the external tool.

Call Client.is_connected() to see if the attempt was successful.

is_connected()[source]

Returns true if client is connected to the external tool.