py2neo.wiring – Low-level network operations

Low-level module for network communication.

This module provides a convenience socket wrapper class (Wire) as well as classes for modelling IP addresses, based on tuples.

class py2neo.wiring.Address

Address of a machine on a network.

family = None

Address family (AF_INET or AF_INET6)

exception py2neo.wiring.BrokenWireError(*args, **kwargs)

Raised when a connection is broken by the network or remote peer.

class py2neo.wiring.IPv4Address

Address subclass, specifically for IPv4 addresses.

class py2neo.wiring.IPv6Address

Address subclass, specifically for IPv6 addresses.

class py2neo.wiring.Wire(s, on_broken=None)

Buffered socket wrapper for reading and writing bytes.

broken

Flag indicating whether this connection has been closed remotely.

close()

Close the connection.

closed

Flag indicating whether this connection has been closed locally.

local_address

The local Address to which this connection is bound.

classmethod open(address, timeout=None, keep_alive=False, on_broken=None)

Open a connection to a given network Address.

Parameters:

• address –
• timeout –
• keep_alive –
• on_broken – callback for when the wire is broken after a successful connection has first been established (this does not trigger if the connection never opens successfully)

Returns:

Wire object

Raises:

WireError – if connection fails to open

peek()

Return any buffered unread data.

read(n)

Read bytes from the network.

remote_address

The remote Address to which this connection is bound.

secure(verify=True, hostname=None)

Apply a layer of security onto this connection.

send(final=False)

Send the contents of the output buffer to the network.

write(b)

Write bytes to the output buffer.

exception py2neo.wiring.WireError(*args, **kwargs)

Raised when a connection error occurs.

Parameters:

• idle_time –
• bytes_sent –
• bytes_received –

class py2neo.wiring.WireRequestHandler(request, client_address, server)

Base handler for use with the socketserver module that wraps the request attribute as a Wire object.