org.jlab.coda.cMsg.cMsgDomain.subdomains

Class cMsgMessageDeliverer

java.lang.Object

org.jlab.coda.cMsg.cMsgDomain.subdomains.cMsgMessageDeliverer

All Implemented Interfaces:

cMsgDeliverMessageInterface

public class cMsgMessageDeliverer
extends java.lang.Object
implements cMsgDeliverMessageInterface

This class delivers messages from the subdomain handler objects in the cMsg domain to a particular client.

Various types of messages may be sent. These are defined to be:

• cMsgConstants.msgGetResponse for a message sent in response to a cMsg.sendAndGet(org.jlab.coda.cMsg.cMsgMessage, int)

• cMsgConstants.msgServerGetResponse for a message sent in response to a cMsgServerClient.serverSendAndGet(org.jlab.coda.cMsg.cMsgMessage, java.lang.String, org.jlab.coda.cMsg.cMsgCallbackInterface) with a return acknowlegment

• cMsgConstants.msgSubscribeResponse for a message sent in response to a cMsg.subscribe(java.lang.String, java.lang.String, org.jlab.coda.cMsg.cMsgCallbackInterface, java.lang.Object) with a return acknowlegment

• cMsgConstants.msgShutdownClients for a message to shutdown the receiving client

• cMsgConstants.msgSyncSendResponse for an int sent in response to a cMsg.syncSend(org.jlab.coda.cMsg.cMsgMessage, int)

• cMsgConstants.msgServerRegistrationLockResponse for an int sent in response to a cMsgServerClient.registrationLock(int)

• cMsgConstants.msgServerCloudLockResponse for an int sent in response to a cMsgServerClient.cloudLock(int)

• cMsgConstants.msgServerSendClientNamesResponse for an int sent in response to a cMsgServerClient.getClientNamesAndNamespaces()

Field Summary

Fields

Modifier and Type	Field and Description
(package private) boolean	blocking
(package private) java.nio.ByteBuffer	buffer Direct buffer for writing nonblocking IO.

Constructor Summary

Constructors

Constructor and Description
cMsgMessageDeliverer() Create a message delivering object for use with one specific client.

Method Summary

Modifier and Type	Method and Description
void	close() Method to close all streams and sockets.
void	createClientConnection(java.nio.channels.SocketChannel channel, boolean blocking) Creates a socket communication channel to a client.
void	deliverMessage(cMsgMessage msg, int msgType) Method to deliver a message from a domain server's subdomain handler to a client.
void	deliverMessage(int i, int j, int msgType) Method to deliver an integer from a domain server's subdomain handler to a client.
void	deliverMessage(java.lang.String[] strs, int msgType) Method to deliver an array of string from a domain server's subdomain handler to a client.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

blocking

boolean blocking

buffer

java.nio.ByteBuffer buffer

Direct buffer for writing nonblocking IO.

Constructor Detail

cMsgMessageDeliverer

public cMsgMessageDeliverer()
                     throws java.io.IOException

Create a message delivering object for use with one specific client.

Throws:

java.io.IOException - if cannot establish communication with client

Method Detail

close

public void close()

Method to close all streams and sockets.

Specified by:

close in interface cMsgDeliverMessageInterface

deliverMessage

public void deliverMessage(cMsgMessage msg,
                           int msgType)
                    throws java.io.IOException,
                           cMsgException

Method to deliver a message from a domain server's subdomain handler to a client.

Specified by:

deliverMessage in interface cMsgDeliverMessageInterface

Parameters:

msg - message to sent to client

msgType - type of communication with the client

Throws:

java.io.IOException - if the message cannot be sent over the channel or client returns an error

cMsgException - if connection to client has not been established

deliverMessage

public void deliverMessage(int i,
                           int j,
                           int msgType)
                    throws java.io.IOException,
                           cMsgException

Method to deliver an integer from a domain server's subdomain handler to a client.

Specified by:

deliverMessage in interface cMsgDeliverMessageInterface

Parameters:

i - integer to sent to client

j - integer to sent to client

msgType - type of communication with the client

Throws:

java.io.IOException - if the message cannot be sent over the channel or client returns an error

cMsgException - if connection to client has not been established

deliverMessage

public void deliverMessage(java.lang.String[] strs,
                           int msgType)
                    throws java.io.IOException,
                           cMsgException

Method to deliver an array of string from a domain server's subdomain handler to a client.

Specified by:

deliverMessage in interface cMsgDeliverMessageInterface

Parameters:

strs - array of strings to sent to client

msgType - type of communication with the client

Throws:

java.io.IOException - if the message cannot be sent over the channel or client returns an error

cMsgException - if connection to client has not been established

createClientConnection

public void createClientConnection(java.nio.channels.SocketChannel channel,
                                   boolean blocking)
                            throws java.io.IOException

Creates a socket communication channel to a client.

Parameters:

channel - channel to client

blocking - is socket blocking (true) or nonblocking (false) ?

Throws:

java.io.IOException - if socket cannot be created