g4ds.communicationmanager.EndpointManager

Package g4ds :: Module communicationmanager :: Class EndpointManager

[show private | hide private]

Class EndpointManager

Maintains the list of endpoints.

Method Summary
	`__init__(self, loadFromDatabase)` Initialises the manager with the subjacent database.
	`__str__(self)` Some basic information about the object
	`addEndpoint(self, endpoint, persistent)` Add one endpoint to the manager.
	`findEndpoint(self, memberid, communityid, protocolname, algorithmname)` There is a problem to find the correct endpoint instance for incoming message.
	`getEndpoint(self, endpointId)` Returns the endpoint instance for the given endpoint id.
`List` of `Endpoint`	`getEndpoints(self)` Returns a list of all saved endpoints.
`List` of `Endpoint`	`getEndpointsForMember(self, memberid, communityid, communityNegativeList)` Provides a list of endpoints for a certain member.
	`removeEndpoint(self, endpointid)` Removes the endpoint with the given id from the manager (and the database if connected).
	`removeEndpointsForMember(self, memberid)` Removes all endpoints from the manager (and database) for the member with the given id.

Instance Variable Summary
`communicationmanager_db.CommDB`	`_comm_db`: Communication Database Connector
`Boolean`	`_dbconnected`: Indicates, whether the manager is connected to a database; hence whether the changes shall be written through
`Dict` (`String` \| `Endpoint`)	`_endpoints`: Dictionary, maintaining the endpoints - accessable by its id

Method Details

init(self, loadFromDatabase=1)
(Constructor)

Initialises the manager with the subjacent database.

Parameters:: loadFromDatabase - Indicates, whether the manager shall be initialised from the database backend
(type=Boolean)

str(self)
(Informal representation operator)

Some basic information about the object

addEndpoint(self, endpoint, persistent=1)

Add one endpoint to the manager.

Parameters:: endpoint - Endpoint to be added
(type=Endpoint); persistent - Indicates, whether the protocol shall be written through to the database
(type=Boolean)

findEndpoint(self, memberid, communityid, protocolname, algorithmname)

There is a problem to find the correct endpoint instance for incoming message.

A function inside the db connector solves this problem. All the known information is put togehter, and voila, we have an endpoint id.

getEndpoint(self, endpointId)

Returns the endpoint instance for the given endpoint id.

getEndpoints(self)

Returns a list of all saved endpoints.

Returns:: List of all endpoints
(type=List of Endpoint)

getEndpointsForMember(self, memberid, communityid=None, communityNegativeList=[])

Provides a list of endpoints for a certain member.

Parameters:: memberid - ID of the member the returned endpoints belong to
(type=String); communityid - ID of the community that should be used; might be None
(type=String)

Returns:: List of endpoints the requested member is owner of
(type=List of Endpoint)

removeEndpoint(self, endpointid)

Removes the endpoint with the given id from the manager (and the database if connected).

removeEndpointsForMember(self, memberid)

Removes all endpoints from the manager (and database) for the member with the given id.

Instance Variable Details

_comm_db

Communication Database Connector

Type:: communicationmanager_db.CommDB

_dbconnected

Indicates, whether the manager is connected to a database; hence whether the changes shall be written through

Type:: Boolean

_endpoints

Dictionary, maintaining the endpoints - accessable by its id

Type:: Dict (String | Endpoint)

Generated by Epydoc 2.0 on Sat Oct 22 22:52:47 2005

http://epydoc.sf.net