CIMListener provides the interfaces that allows CIMListeners to be created and managed.

Documentation

CIMListener provides the interfaces that allows CIMListeners to be created and managed. CIMListeners are the receivers for cim/xml indications. ATTN: KS needs to be completed.TBD

Inheritance:

Public Methods

	CIMListener (Uint32 portNumber, SSLContext* sslContext=NULL) Constructs a CIMListener object.
	~CIMListener () Destructor of a CIMLIstener object
Uint32	getPortNumber () const Returns the socket port number
SSLContext*	getSSLContext () const Returns the SSL context
void	setSSLContext (SSLContext* sslContext) Sets the SSL context
void	start () Starts for listening
void	stop () Stops listening
Boolean	isAlive () const Returns if the listener is active
Boolean	addConsumer (CIMIndicationConsumer* consumer) Adds a CIMIndicationConsumer to the listener
Boolean	removeConsumer (CIMIndicationConsumer* consumer) Removes a CIMIndicationConsumer from the listener.

CIMListener(Uint32 portNumber, SSLContext* sslContext=NULL)

Constructs a CIMListener object.

Parameters:

portNumber - the specified socket port the listener will listen to
sslContext - the specifed SSL context

~CIMListener()

Destructor of a CIMLIstener object

Uint32 getPortNumber() const

Returns the socket port number

Returns:

the socket port number.

SSLContext* getSSLContext() const

Returns the SSL context

Returns:

the SSL context.

void setSSLContext(SSLContext* sslContext)

Sets the SSL context

Parameters:

the - SSL context.

void start()

Starts for listening

void stop()

Stops listening

Boolean isAlive() const

Returns if the listener is active

Returns:

true if the listener is active; false otherwise.

Boolean addConsumer(CIMIndicationConsumer* consumer)

Adds a CIMIndicationConsumer to the listener

Parameters:

consumer - the CIMIndicationConsumer to add.

Returns:

true if the indication consumer has been added successfully false otherwise.

Boolean removeConsumer(CIMIndicationConsumer* consumer)

Removes a CIMIndicationConsumer from the listener.

Parameters:

the - CIMIndicationConsumer to remove.

Returns:

true if the indication consumer has been removed successfully false otherwise.

This class has no child classes.

Alphabetic index HTML hierarchy of classes or Java