WCF service for call center clients More...

Inherits IWcfCallCenterService.

Public Member Functions
CallCenterConnectionDto	Connect (UserCredentialsDto credentials)
	Method for handling call center client connections. This method has to be invoked by all call center clients before any operations on the server can be performed. More...

void	Reconnect (CallCenterConnectionDto user)
	Method for handling call center client reconnections. More...

void	Disconnect (CallCenterConnectionDto user)
	Method for handling call center client disconnects. Every call center client should invoke this method before closing connection. More...

List< ConnectionDto >	GetActiveConnections (CallCenterConnectionDto user)
	Requests a complete list of all mobile emergency client connections currently active on the server. More...

void	OpenConnectionForProcessing (CallCenterConnectionDto user, ConnectionDto connection)
	Opens a mobile emergency client connection for handling in this call center connection. More...

void	TransferConnection (CallCenterConnectionDto user, List< CallCenterConnectionDto > targetCallCenterConnections)
	Transfers a mobile emergency client connection from the requesting call center connection to the specified call center connection(s). More...

void	SetConnectionPriority (CallCenterConnectionDto user, ConnectionDto connection)
	Changes the priority for the provided emergency connection. The new priority must be set on the ConnectionDto supplied as a parameter. More...

void	MoveConnectionToHold (CallCenterConnectionDto user, ConnectionDto connection)
	Puts an emergency connection on hold. The invocating call center connection will no longer be an attached handler of the connection. More...

void	MarkProcessedCloseConnection (CallCenterConnectionDto user, ConnectionDto connection)
	Closes the emergency connection and marks it processed. If there are multiple attached handlers on the connection, it is sufficient for one handler to close the connection. Change to the connection state will be propagated to other attached handlers. More...

void	RequestRemoteAction (CallCenterConnectionDto user, ConnectionDto connection, RemoteActionDto action)
	Requests an operation with no parameters to be executed by the provided mobile emergency connection. More...

void	RequestMediaUpstreaming (CallCenterConnectionDto user, ConnectionDto connection, MediaConfigurationDto mediaConfiguration)
	Requests the mobile emergency client to start upstreaming media according to the provided configuration. More...

void	RequestMediaDownstreaming (CallCenterConnectionDto user, ConnectionDto connection, string mediaUrl)
	Requests the mobile emergency client to start downstreaming and playback of media available at the provided url. More...

void	RequestStartMeasurement (CallCenterConnectionDto user, ConnectionDto connection, MeasurementInstrumentDto measurementDevice)
	Requests the mobile emergency client enable the specified masurement instrument and start uploading measurement data from it. More...

void	RequestStopMeasurement (CallCenterConnectionDto user, ConnectionDto connection, MeasurementInstrumentDto measurementDevice)
	Requests the mobile emergency client to disable the specified measurement instrument and stop uploading data from it. More...

void	SendTextMessage (CallCenterConnectionDto user, ConnectionDto connection, TextMessageDto textMessage)
	Sends a text based message to the specified mobile emergency client More...

bool	UploadMediaSegment (CallCenterConnectionDto user, MediaInformationDto mediaInfo, byte[] mediaData)
	Uploads a segment of media from the call center client to the server. The media is forwarded to the mobile emergency client attached to the connection that the call center client currently is handling, if any. More...

int	Ping (int pingSequence)

Detailed Description

WCF service for call center clients

<author>Veli-Mikko Puupponen</author> Implements IWcfCallCenterService.

See also: HalyriServer.Services.IWcfCallCenterService

Member Function Documentation

CallCenterConnectionDto Connect ( UserCredentialsDto credentials )

Method for handling call center client connections. This method has to be invoked by all call center clients before any operations on the server can be performed.

Parameters

credentials Call center client login credentials

Returns: CallCenterConnectionDto used to identify the call center client in subsequent operations

Implements IWcfCallCenterService.

void Disconnect ( CallCenterConnectionDto user )

Method for handling call center client disconnects. Every call center client should invoke this method before closing connection.

Parameters

user	CallCenterConnectionDto identifying the existing call center client user connection

Implements IWcfCallCenterService.

List<ConnectionDto> GetActiveConnections ( CallCenterConnectionDto user )

Requests a complete list of all mobile emergency client connections currently active on the server.

Throws ConnectionFault if the provided CallCenterConnection is not a valid active connection.

Parameters

user	CallCenterConnectionDto identifying the existing call center client user connection

Returns: List of active emergency connections

Implements IWcfCallCenterService.

void MarkProcessedCloseConnection	(	CallCenterConnectionDto	user,
		ConnectionDto	connection
	)

Closes the emergency connection and marks it processed. If there are multiple attached handlers on the connection, it is sufficient for one handler to close the connection. Change to the connection state will be propagated to other attached handlers.

Throws ConnectionFault, if the CallCenterConnectionDto is not associated with a valid call center client connection Throws TargetStateFault if connection is already processed, does not exist or has disconnected

Parameters

user	CallCenterConnectionDto identifying the existing call center client user connection
connection	ConnectioDto identifying the target mobile emergency client connection

Implements IWcfCallCenterService.

void MoveConnectionToHold	(	CallCenterConnectionDto	user,
		ConnectionDto	connection
	)

Puts an emergency connection on hold. The invocating call center connection will no longer be an attached handler of the connection.

Throws ConnectionFault, if the CallCenterConnectionDto is not associated with a valid call center client connection Throws TargetStateFault if connection is already processed, does not exist or has disconnected

Parameters

user	CallCenterConnectionDto identifying the existing call center client user connection
connection	ConnectioDto identifying the mobile emergency client

Implements IWcfCallCenterService.

void OpenConnectionForProcessing	(	CallCenterConnectionDto	user,
		ConnectionDto	connection
	)

Opens a mobile emergency client connection for handling in this call center connection.

Throws ConnectionFault, if the provided CallCenterConnectionDto is invalid Throws TargetStateFault if connection is already processed, does not exist or the requesting call center client is already an associated handler for this connection.

Parameters

user	CallCenterConnectionDto identifying the existing call center client user connection
connection	ConnectioDto for the connection to be opened for handling.

Implements IWcfCallCenterService.

void Reconnect ( CallCenterConnectionDto user )

Method for handling call center client reconnections.

Parameters

user	CallCenterConnectionDto identifying the existing call center client user connection

Implements IWcfCallCenterService.

void RequestMediaDownstreaming	(	CallCenterConnectionDto	user,
		ConnectionDto	connection,
		string	mediaUrl
	)

Requests the mobile emergency client to start downstreaming and playback of media available at the provided url.

Throws ConnectionFault, if the CallCenterConnectionDto is not associated with a valid call center client connection Throws TargetStateFault if connection is already processed, does not exist or has disconnected

Parameters

user	CallCenterConnectionDto identifying the existing call center client user connection
connection	ConnectioDto identifying the target mobile emergency client connection.
mediaUrl	Location of the media to play back at the mobile client

Implements IWcfCallCenterService.

void RequestMediaUpstreaming	(	CallCenterConnectionDto	user,
		ConnectionDto	connection,
		MediaConfigurationDto	mediaConfiguration
	)

Requests the mobile emergency client to start upstreaming media according to the provided configuration.

Throws ConnectionFault, if the CallCenterConnectionDto is not associated with a valid call center client connection Throws TargetStateFault if connection is already processed, does not exist or has disconnected

Parameters

user	CallCenterConnectionDto identifying the existing call center client user connection
connection	ConnectioDto identifying the target mobile emergency client connection.
mediaConfiguration	Quality parameters for the requested media

Implements IWcfCallCenterService.

void RequestRemoteAction	(	CallCenterConnectionDto	user,
		ConnectionDto	connection,
		RemoteActionDto	action
	)

Requests an operation with no parameters to be executed by the provided mobile emergency connection.

Throws ConnectionFault, if the CallCenterConnectionDto is not associated with a valid call center client connection Throws TargetStateFault if connection is already processed, does not exist or has disconnected

Parameters

user	CallCenterConnectionDto identifying the existing call center client user connection
connection	ConnectioDto identifying the target mobile emergency client connection.
action	Request to execute on the remote call center client

Implements IWcfCallCenterService.

void RequestStartMeasurement	(	CallCenterConnectionDto	user,
		ConnectionDto	connection,
		MeasurementInstrumentDto	measurementDevice
	)

Requests the mobile emergency client enable the specified masurement instrument and start uploading measurement data from it.

Throws ConnectionFault, if the CallCenterConnectionDto is not associated with a valid call center client connection Throws TargetStateFault if connection is already processed, does not exist or has disconnected

Parameters

user	CallCenterConnectionDto identifying the existing call center client user connection
connection	ConnectioDto identifying the target mobile emergency client connection.
measurementDevice	Measurement device to enable and start uploading data from

Implements IWcfCallCenterService.

void RequestStopMeasurement	(	CallCenterConnectionDto	user,
		ConnectionDto	connection,
		MeasurementInstrumentDto	measurementDevice
	)

Requests the mobile emergency client to disable the specified measurement instrument and stop uploading data from it.

Throws ConnectionFault, if the CallCenterConnectionDto is not associated with a valid call center client connection Throws TargetStateFault if connection is already processed, does not exist or has disconnected

Parameters

user	CallCenterConnectionDto identifying the existing call center client user connection
connection	ConnectioDto identifying the target mobile emergency client connection.
measurementDevice	Measurement device to disable and stop uploading data from

Implements IWcfCallCenterService.

void SendTextMessage	(	CallCenterConnectionDto	user,
		ConnectionDto	connection,
		TextMessageDto	textMessage
	)

Sends a text based message to the specified mobile emergency client

Throws ConnectionFault, if the CallCenterConnectionDto is not associated with a valid call center client connection Throws TargetStateFault if connection is already processed, does not exist or has disconnected

Parameters

user	CallCenterConnectionDto identifying the existing call center client user connection
connection	ConnectioDto identifying the target mobile emergency client connection.
textMessage	Test message to send to the specified emergency client

Implements IWcfCallCenterService.

void SetConnectionPriority	(	CallCenterConnectionDto	user,
		ConnectionDto	connection
	)

Changes the priority for the provided emergency connection. The new priority must be set on the ConnectionDto supplied as a parameter.

Throws ConnectionFault, if the CallCenterConnectionDto is not associated with a valid call center client connection Throws TargetStateFault if connection is already processed, does not exist or has disconnected

Parameters

user	CallCenterConnectionDto identifying the existing call center client user connection thas is a handler for the connection to be modified.

Parameters

connection ConnectioDto identifying the mobile emergency client

Implements IWcfCallCenterService.

void TransferConnection	(	CallCenterConnectionDto	user,
		List< CallCenterConnectionDto >	targetCallCenterConnections
	)

Transfers a mobile emergency client connection from the requesting call center connection to the specified call center connection(s).

Throws ConnectionFault, if the CallCenterConnectionDto is not associated with a valid call center client connection Throws TargetStateFault if connection is already processed, does not exist or has disconnected

Parameters

user	CallCenterConnectionDto identifying the existing call center client user connection thas is a handler for the connection to be transferred.

Parameters

targetCallCenterConnections CallCenterConnectionDtos identifying the transfer targets

Implements IWcfCallCenterService.

bool UploadMediaSegment	(	CallCenterConnectionDto	user,
		MediaInformationDto	mediaInfo,
		byte[]	mediaData
	)

Uploads a segment of media from the call center client to the server. The media is forwarded to the mobile emergency client attached to the connection that the call center client currently is handling, if any.

Throws ParameterFault if supplied parameters are null or incorrect. Throws TargetStateFault if the connection is processed or not a connection that the invoking call center connection is processing.

Parameters

user	CallCenterConnectionDto identifying the existing call center client user connection
mediaInfo	Description of the media
mediaData	Media data bytes

Implements IWcfCallCenterService.

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

WcfCallCenterService.svc.cs

Public Member Functions

Detailed Description

Member Function Documentation