transport.ConnectionBuilder.ConnectionBuilder Class Reference

The builder is used to encapsulation routine of creation various type of connections. More...

Inheritance diagram for transport.ConnectionBuilder.ConnectionBuilder:

Collaboration diagram for transport.ConnectionBuilder.ConnectionBuilder:

Public Member Functions
def	__init__ (self, id_generator)
	constructor More...
def	build (self, connect_type, connect_params, endPointType=consts.CLIENT_CONNECT)
	build a connection More...

Public Attributes
	zmq_context
	zmq_poller
	id_generator
	builders

Private Member Functions
def	__admin_connection (self, connect_params, endPointType)
	helper function More...
def	__data_connection (self, connect_params, endPointType)
	helper function More...

Detailed Description

The builder is used to encapsulation routine of creation various type of connections.

Factory is used to create various connection objects

Definition at line 21 of file ConnectionBuilder.py.

Constructor & Destructor Documentation

__init__()

def transport.ConnectionBuilder.ConnectionBuilder.__init__	(		self,
			id_generator
	)

constructor

Init global variable

Parameters

id_generator

an instance of IDGenerator object Init global variable

Definition at line 30 of file ConnectionBuilder.py.

  def __init__(self, id_generator):
    '''
    Init global variable
    '''
    self.zmq_context = zmq.Context()  # pylint: disable=E1101
    self.zmq_poller = zmq.Poller()  # pylint: disable-msg=E1101
    self.id_generator = id_generator
    self.builders = dict({consts.ADMIN_CONNECT_TYPE : self.__admin_connection,
                     consts.DATA_CONNECT_TYPE : self.__data_connection})

Member Function Documentation

__admin_connection()

def transport.ConnectionBuilder.ConnectionBuilder.__admin_connection (   self,   connect_params,   endPointType  )

private

helper function

is used for create admin connection type

Parameters

connect_params	an instance of ConnectionParams
endpointType	type of endpoint (client or server) return zmq.Socket

Definition at line 59 of file ConnectionBuilder.py.

  def __admin_connection(self, connect_params, endPointType):
    sock = self.__data_connection(connect_params, endPointType)
    #@todo need set extra params
    return sock

Here is the call graph for this function:

__data_connection()

def transport.ConnectionBuilder.ConnectionBuilder.__data_connection (   self,   connect_params,   endPointType  )

private

helper function

is used for create data connection type

Parameters

connect_params	an instance of ConnectionParams
endpointType	type of endpoint (client or server) return zmq.Socket

Definition at line 71 of file ConnectionBuilder.py.

  def __data_connection(self, connect_params, endPointType):
    sock = None
    addr = "tcp://" + connect_params.host + ":" + str(connect_params.port)
    if endPointType == consts.CLIENT_CONNECT:
      sock = self.zmq_context.socket(zmq.DEALER)  # pylint: disable=E0602,E1101
      sock.setsockopt(zmq.IDENTITY, self.id_generator.get_connection_uid())  # pylint: disable=E0602,E1101
      sock.connect(addr)

    if endPointType == consts.SERVER_CONNECT:
      sock = self.zmq_context.socket(zmq.ROUTER)  # pylint: disable=E0602,E1101
      sock.bind(addr)

    return sock

build()

def transport.ConnectionBuilder.ConnectionBuilder.build	(		self,
			connect_type,
			connect_params,
			endPointType = consts.CLIENT_CONNECT
	)

build a connection

Parameters

connect_type	type of connection(DATA_CONNECT_TYPE or ADMIN_CONNECT_TYPE)
connect_params	an instance of ConnectionParams
endpointType	type of endpoint (client or server)

Returns

Connection

Definition at line 48 of file ConnectionBuilder.py.

  def build(self, connect_type, connect_params, endPointType=consts.CLIENT_CONNECT):
    sock = self.builders[connect_type](connect_params, endPointType)
    return Connection(sock, self.zmq_poller, endPointType)

Member Data Documentation

builders

transport.ConnectionBuilder.ConnectionBuilder.builders

Definition at line 37 of file ConnectionBuilder.py.

id_generator

transport.ConnectionBuilder.ConnectionBuilder.id_generator

Definition at line 36 of file ConnectionBuilder.py.

zmq_context

transport.ConnectionBuilder.ConnectionBuilder.zmq_context

Definition at line 34 of file ConnectionBuilder.py.

zmq_poller

transport.ConnectionBuilder.ConnectionBuilder.zmq_poller

Definition at line 35 of file ConnectionBuilder.py.

---

The documentation for this class was generated from the following file:

• sources/hce/transport/ConnectionBuilder.py