Package wtf :: Package opi :: Module listener :: Class SocketDecorator

[frames] | no frames]

Class SocketDecorator

object --+
         |
        SocketDecorator

Known Subclasses:

Socket decorating container

Derive from this container in order to build new concrete containers. These containers are necessary for proper duplicate/warning/error handling, because we need some context for the socket. The socket ordering is also defined in these containers (via __cmp__).

See Also: UnixSocket, InetSocket

Instance Methods

__init__(self, socket, bindspec)
Initialization

source code

int

__cmp__(self, other)
Compare 3-way with another object

source code

bool

__eq__(self, other)
Compary (2-way) by identity

source code

str

__repr__(self)
String representation of the object (suitable for debugging)

source code

__del__(self)
Destructor

source code

__getattr__(self, name)
Delegate all undefined symbol requests to the real socket

source code

bind(self)
Bind the socket according to its bindspec

source code

int

family(self)
Determine the socket address family

source code

any

key(self)
Determine the key of the socket, derived from the bindspec

source code

any

anykey(self)
Determine the key of the socket if bindspec would point to ANY

source code

Inherited from object: __delattr__, __format__, __getattribute__, __hash__, __new__, __reduce__, __reduce_ex__, __setattr__, __sizeof__, __str__, __subclasshook__

Class Variables

dict _famcomp = {1: 0, 2: 2, 10: 1}
Index for address family comparisons

Instance Variables

str bindspec
The bind specification from the config

socket.socket realsocket
The actual socket object

Properties

Inherited from object: __class__

Method Details

init(self, socket, bindspec)
(Constructor)

Initialization

Parameters:

socket (socket.socket) - The socket object to decorate
bindspec (str) - The bind specification from config

Overrides: object.__init__

cmp(self, other)
(Comparison operator)

Compare 3-way with another object

Comparison is done by the socket family index. If the other object is not a SocketDecorator, the id() s are compared.

Parameters:

other (SocketDecorator) - The other object

Returns: int

Comparison result (-1, 0, 1) for self being less, equal or greater than/to other

Raises:

NotImplementedError - The socket family of either socket is not in the index

eq(self, other)
(Equality operator)

Compary (2-way) by identity

Parameters:

other (SocketDecorator) - The other object

Returns: bool

Are the objects identical?

repr(self)
(Representation operator)

String representation of the object (suitable for debugging)

Returns: str: The string representation
Overrides: object.__repr__

getattr(self, name)
(Qualification operator)

Delegate all undefined symbol requests to the real socket

Parameters:

name (str) - The symbol to look up

family(self)

Determine the socket address family

Returns: int: The family

key(self)

Determine the key of the socket, derived from the bindspec

This key can be considered a normalized version of the bindspec. It has to be hashable.

Returns: any: The key

anykey(self)

Determine the key of the socket if bindspec would point to ANY

Returns: any: The key

See Also: key