riaps.run.insPort module

Created on Jan 9, 2017

@author: riaps

class riaps.run.insPort.InsPort(parentPart, portName, portSpec)

Bases: Port

classdocs

activate()

Activate the port object. Subclasses can override this method.

deactivate()

Deactivate the port object. Subclasses can override this method.

getContext()

getInfo()

Retrieve configuration information about the port. Abstract, subclasses must implement this method.

Returns:

a tuple containing the name of the port’s type: req,rep,clt,srv,qry,ans,pub,sub,ins,or tim; the kind of the port (global, local, internal); the name of the port object; the name of the message type; the host and the port number.

Return type:

PortInfo

getSocket()

Return the socket(s) used by the port object. Abstract, subclasses must implement this method.

Returns:

a low-level socket

Return type:

zmq.Socket

get_identity()

get_plug_identity(plug)

inSocket()

Return True if the socket can be used for input. Abstract, subclasses must implement this method.

Returns:

logical value indicating whether the socket is for input.

Type:

bool

ins_port_recv(is_pyobj)

ins_port_send(msg, is_pyobj)

recv()

Receive a byte array (if possible) through the port

Used for receiving a message that is subsequently deserialized.

Returns:

a message packed into a bytes.

Return type:

bytes

recv_pyobj()

Receive a Python data object (if possible) through the port. Abstract, subclasses must implement this method.

The raw message received is deserialized using pickle and returned. Messages received this way had to be sent using the send_pyobj method.

Returns:

a Python data object

Type:

any Python data type

reset()

Reset the port object. Subclasses can override this method.

Reset is to be used when a send or receive operation fails and the port needs to be re-initialized.

send(msg)

Send a byte array (if possible) out through the port.

Used for sending a message that has been serialized into bytes previously.

Parameters:

msg – the message packed into a bytes

Return type:

bytes

send_pyobj(msg)

Send a Python data object (if possible) out through the port. Abstract, subclasses must implement this method.

The object is serialized using pickle and sent. Messages sent using this method are received using the recv_pyobj method.

Parameters:

msg (any Python data type) – the message to be sent.

set_identity(identity)

setup()

Initialize the port object (after construction but before socket creation). Abstract, subclasses must implement this method.

setupPlug(thread)

setupSocket(owner)

Setup the socket. Abstract, subclasses must implement this method.

Parameters:

owner (Component) – The Component the port belongs to. This operation must be called from the component thread only.

terminate()

Terminate all activities of the port. Subclasses can override this method.