py2p 0.3.186

Constructor

pathfinding_message(protocol, msg_type, sender, payload, compressions=None) pathfinding_message.feed_string(protocol, string, sizeless=False, compressions=None)

• protocol: The protocol this message uses

• msg_type: The chief flag this message uses, to broadcast intent

• sender: The SHA384-based sender ID

• payload: A list of additional packets to send

• compressions: A list of possible compression methods used/to use

• string: The raw message to parse

• sizeless: An indicator as to whether this message contains the length header

Constants

• protocol: The protocol this message is sent under

• msg_type: The main flag of the message (ie: ['broadcast', 'waterfall', 'whisper', 'renegotiate'])

• sender: The sender id of this message

• time: An int of the message’s timestamp

• compression: The list of compression methods this message may be under

• compression_fail: A debug property which is triggered if you give compression methods, but the message fed from feed_string is actually in plaintext

Properties

• payload: Returns the message’s payload

• compression_used: Returns the compression method used

• time_58: Returns the timestamp in base_58

• id: Returns the message’s id

• len: Returns the messages length header

• packets: Returns a list of the packets in this message, excluding the length header

• string: Returns a string version of the message, including the length header

• __non_len_string: Returns the string of this message without the size header

Methods

• __len__(): Returns the length of this message excluding the length header

Class Methods

• feed_string(ptorocol, string, sizeless=False, compressions=None): Given a protocol, a string or bytes, process this into a pathfinding_message. If compressions are enabled, you must provide a list of possible methods. If the size header is not included, you must specify this with sizeless=True. Possible errors:

  • AttributeError: Fed a non-string, non-bytes argument

  • AssertionError: Initial size header is incorrect

  • Exception: Unrecognized compression method fed in compressions

  • struct.error: Packet headers are incorrect OR unrecognized compression

  • IndexError: See struct.error

• sanitize_string(string, sizeless=False): Given an str or bytes, returns a bytes object with no size header. Possible errors:

  • AttributeError: Fed a non-string, non-bytes argument

  • AssertionError: Initial size header is incorrect

• decompress_string(string, compressions=None): Given a bytes object and list of possible compression methods, returns a decompressed version and a bool indicating if decompression failed. If decompression occurs, this will always return bytes. If not, it will return whatever you pass in. Decompression failure is defined as it being unable to decompress despite a list of possible methods being provided. Possible errors:

  • Exception: Unrecognized compression method fed in compressions

• process_string(string): Given a bytes, return a list of its contained packets. Possible errors:

  • IndexError: Packet headers are incorrect OR not fed plaintext

  • struct.error: See IndexError OR fed non-bytes object

Constructor

message(msg, server)

• msg: This contains the pathfinding_message you received

• server: The base_socket which received the message

Constants

• msg: This contains the pathfinding_message you received

• server: The base_socket which received the message

Properties

• time: The UTC Unix time at which the message was sent

• sender: The original sender’s ID

• protocol: The protocol you received this under

• packets: Returns a list of the packets received, with the first item being the subflag

• id: Returns the SHA384-based message id

Methods

• reply(*args): Sends a whisper to the original sender with the arguments being each packet after that. If you are not connected, it uses the request/response mechanism to try making a connection

Constructor

protocol(subnet, encryption)

Constants

• subnet: A flag to allow people with the same package version to operate different networks

• encryption: Defines the encryption standard used on the socket

Properties

• id: Returns the SHA256-based protocol id

Variables

• debug_level: The verbosity of the socket with debug prints

• routing_table: The current dict of peers in format {id: connection}

• awaiting_ids: A list of connections awaiting a handshake

• queue: A deque of recently received messages

• daemon: This node’s base_daemon object

Properties

• outgoing: A list of ids for outgoing connections

• incoming: A list of ids for incoming connections

• status: Returns "Nominal" or base_socket.daemon.exceptions if there are Exceptions collected

Methods

• recv(quantity=1): Receive messages; If quantity != 1, returns a list of messages, otherwise returns one

• __print__(*args, level=None): Prints debug information if level >= debug_level

Constructor

base_daemon(addr, port, server, prot=default_protocol)

• addr: The address it should bind its incoming connection to

• port: The port it should bind its incoming connection to

• server: This daemon’s base_socket

• prot: This daemon’s protocol

Variables

• protocol: This daemon’s protocol object

• server: A pointer to this daemon’s base_socket

• sock: This daemon’s socket object

• alive: A checker to shutdown the daemon. If False, its thread will stop running eventually.

• exceptions: A list of unhandled Exceptions raised in mainloop

• daemon: A Thread which runs through mainloop

Methods

• __print__(*args, level=None): Prints debug information if level >= server.debug_level

Constructor

base_connection(sock, server, prot=default_protocol, outgoing=False)

• sock: A socket.socket

• server: This node’s base_socket

• prot: This node’s protocol

• outgoing: Whether or not this node is an outgoing connection

Variables

• sock: This connection’s socket object

• server: A pointer to this connection’s base_socket object

• protocol: This connection’s protocol object

• outgoing: A bool that states whether this connection is outgoing

• buffer: A list of recently received characters

• id: This node’s SHA384-based id

• time: The time at which this node last received data

• addr: This node’s outward-facing address

• compression: A list of this node’s supported compression methods

• last_sent: A copy of the most recently sent whisper or broadcast

• expected: The number of bytes expected in the next message

• active: A bool which says whether the next message is a size header, or a message (True if message)

Methods

• fileno(): Returns sock’s file number

• collect_incoming_data(data): Adds new data to the buffer

• find_terminator(): Determines if a message has been fully received (name is a relic of when this had an end_of_tx flag)

• __print__(*args, level=None): Prints debug information if level >= server.debug_level

Constructor

mesh_socket(addr, port, prot=default_protocol, out_addr=None, debug_level=0)

• addr: The address you’d like to bind to

• port: The port you’d like to bind to

• prot: The protocol you’d like to use

• out_addr: Your outward-facing address, if that is different from (addr, port)

• debug_level: The verbosity at which this and its associated mesh_daemon prints debug information

Variables

• protocol: A protocol object which contains the subnet flag and the encryption method

• debug_level: The verbosity of the socket with debug prints

• routing_table: The current dict of peers in format {id: connection}

• awaiting_ids: A list of connections awaiting a handshake

• outgoing: A list of ids for outgoing connections

• incoming: A list of ids for incoming connections

• requests: A dict of the requests this node has made in format {request_id: delayed_message_contents}

• waterfalls: A deque of metadata for recently received messages

• queue: A deque of recently received messages

• out_addr: A tuple which contains the outward facing address and port

• id: This node’s SHA384-based id

• daemon: This node’s mesh_daemon object

Methods

• connect(addr, port, id=None): Connect to another mesh_socket (and assigns id if specified)

• send(*args, type='broadcast'): Send a message to your peers with each argument as a packet

• recv(quantity=1): Receive messages; If quantity != 1, returns a list of messages, otherwise returns one

• handle_request(msg): Allows the daemon to parse subflag-level actions

• waterfall(msg): Waterfalls a message to your peers

Constructor

mesh_daemon(addr, port, server, prot=default_protocol)

• addr: The address it should bind its incoming connection to

• port: The port it should bind its incoming connection to

• server: This daemon’s mesh_socket

• prot: This daemon’s protocol

Variables

• protocol: This daemon’s protocol object

• server: A pointer to this daemon’s mesh_socket

• sock: This daemon’s socket object

• alive: A checker to shutdown the daemon. If False, its thread will stop running eventually.

• exceptions: A list of unhandled Exceptions raised in mainloop

• daemon: A Thread which runs through mainloop

Methods

• mainloop(): The method through which daemon parses. This runs as long as alive is True, and alternately calls the collect_incoming_data methods of mesh_connections and handle_accept.

• handle_accept(): Deals with incoming connections

• disconnect(handler): Closes a given mesh_connection and removes its information from server

• __print__(*args, level=None): Prints debug information if level >= server.debug_level

Constructor

base_connection(sock, server, prot=default_protocol, outgoing=False)

• sock: A socket.socket

• server: This node’s mesh_socket

• prot: This node’s protocol

• outgoing: Whether or not this node is an outgoing connection

Variables

• sock: This connection’s socket object

• server: A pointer to this connection’s mesh_socket object

• protocol: This connection’s protocol object

• outgoing: A bool that states whether this connection is outgoing

• buffer: A list of recently received characters

• id: This node’s SHA384-based id

• time: The time at which this node last received data

• addr: This node’s outward-facing address

• compression: A list of this node’s supported compression methods

• last_sent: A copy of the most recently sent whisper or broadcast

• expected: The number of bytes expected in the next message

• active: A bool which says whether the next message is a size header, or a message (True if message)

Methods

• fileno(): Returns sock’s file number

• collect_incoming_data(data): Adds new data to the buffer

• find_terminator(): Determines if a message has been fully received (name is a relic of when this had an end_of_tx flag)

• found_terminator(): Deals with any data received when find_terminator returns True

• send(msg_type, *args, id=server.id, time=base.getUTC()): Sends a message via sock

• __print__(*args, level=None): Prints debug information if level >= server.debug_level