AMPS.Client.ProtocolFactory Class Reference

Class which creates Protocols as well as registering and unregistering them from a Dictionary. More...

Static Public Member Functions
static void	register (string name, string msgType)
	Method to register the name of the message and the message type. More...
static void	unregister (string name)
	Method to unregister a message. More...
static Protocol	createProtocol (string name, Properties props)
	Creates a protocol. More...

Detailed Description

Class which creates Protocols as well as registering and unregistering them from a Dictionary.

Member Function Documentation

createProtocol()

static Protocol AMPS.Client.ProtocolFactory.createProtocol ( string  name, Properties  props  )

inlinestatic

Creates a protocol.

Parameters

name	A string which holds the name of the protocol.
props	A Properties object which holds the properties of the protocol.

Exceptions

ProtocolException

The provided name is not a valid protocol.

Returns

This instance so that various operations can be chained together.

register()

static void AMPS.Client.ProtocolFactory.register ( string  name, string  msgType  )

inlinestatic

Method to register the name of the message and the message type.

Parameters

name	A string containing the name of the message.
msgType	A string containing the type of the message.

Exceptions

ProtocolException

The name is already registered

unregister()

static void AMPS.Client.ProtocolFactory.unregister ( string  name )

inlinestatic

Method to unregister a message.

Parameters

name	A string containing the name of the message.

Exceptions

ProtocolException

The provided name is not registered.

---

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

• AMPS.Client/ProtocolFactory.cs