org.jlab.coda.cMsg.cMsgDomain.subdomains

Class FileQueue

java.lang.Object

org.jlab.coda.cMsg.common.cMsgSubdomainAdapter

org.jlab.coda.cMsg.cMsgDomain.subdomains.FileQueue

All Implemented Interfaces:

cMsgSubdomainInterface

public class FileQueue
extends cMsgSubdomainAdapter

cMsg subdomain handler for FileQueue subdomain.

UDL: cMsg:cMsg://host:port/FileQueue/myQueueName?dir=myDirName.

e.g. cMsg:cMsg://ollie/FileQueue/ejw?dir=/home/wolin/qdir.

Stores/retrieves cMsgMessageFull messages from file-based queue.

Version:

1.0

Author:

Elliiott Wolin

Constructor Summary

Constructors

Constructor and Description
FileQueue()

Method Summary

Modifier and Type	Method and Description
void	handleSendAndGetRequest(cMsgMessageFull message) Returns message at head of queue.
void	handleSendRequest(cMsgMessageFull msg) Write message to queue file.
int	handleSyncSendRequest(cMsgMessageFull msg) Write message to queue file.
boolean	hasSend() Method to tell if the "send" cMsg API function is implemented by this interface implementation in the "handleSendRequest" method.
boolean	hasSendAndGet() Method to tell if the "sendAndGet" cMsg API function is implemented by this interface implementation in the "handleSendAndGetRequest" method.
boolean	hasSyncSend() Method to tell if the "syncSend" cMsg API function is implemented by this interface implementation in the "handleSyncSendRequest" method.
void	registerClient(cMsgClientInfo info) Creates files to store messages in.
void	setUDLRemainder(java.lang.String UDLRemainder) Method to give the subdomain handler the appropriate part of the UDL the client used to talk to the domain server.

Methods inherited from class org.jlab.coda.cMsg.common.cMsgSubdomainAdapter

handleClientShutdown, handleShutdownClientsRequest, handleSubscribeAndGetRequest, handleSubscribeRequest, handleUnSendAndGetRequest, handleUnsubscribeAndGetRequest, handleUnsubscribeRequest, hasShutdown, hasSubscribe, hasSubscribeAndGet, hasUnsubscribe

Methods inherited from class java.lang.Object

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

Constructor Detail

FileQueue

public FileQueue()

Method Detail

hasSend

public boolean hasSend()

Method to tell if the "send" cMsg API function is implemented by this interface implementation in the "handleSendRequest" method.

Specified by:

hasSend in interface cMsgSubdomainInterface

Overrides:

hasSend in class cMsgSubdomainAdapter

Returns:

true

hasSendAndGet

public boolean hasSendAndGet()

Method to tell if the "sendAndGet" cMsg API function is implemented by this interface implementation in the "handleSendAndGetRequest" method.

Specified by:

hasSendAndGet in interface cMsgSubdomainInterface

Overrides:

hasSendAndGet in class cMsgSubdomainAdapter

Returns:

true

hasSyncSend

public boolean hasSyncSend()

Method to tell if the "syncSend" cMsg API function is implemented by this interface implementation in the "handleSyncSendRequest" method.

Specified by:

hasSyncSend in interface cMsgSubdomainInterface

Overrides:

hasSyncSend in class cMsgSubdomainAdapter

Returns:

true

setUDLRemainder

public void setUDLRemainder(java.lang.String UDLRemainder)
                     throws cMsgException

Method to give the subdomain handler the appropriate part of the UDL the client used to talk to the domain server.

Specified by:

setUDLRemainder in interface cMsgSubdomainInterface

Overrides:

setUDLRemainder in class cMsgSubdomainAdapter

Parameters:

UDLRemainder - last part of the UDL appropriate to the subdomain handler

Throws:

cMsgException - never

registerClient

public void registerClient(cMsgClientInfo info)
                    throws cMsgException

Creates files to store messages in.

Specified by:

registerClient in interface cMsgSubdomainInterface

Overrides:

registerClient in class cMsgSubdomainAdapter

Parameters:

info - information about client

Throws:

cMsgException - upon bad UDL, cannot create file names or files

handleSendRequest

public void handleSendRequest(cMsgMessageFull msg)
                       throws cMsgException

Write message to queue file.

Specified by:

handleSendRequest in interface cMsgSubdomainInterface

Overrides:

handleSendRequest in class cMsgSubdomainAdapter

Parameters:

msg - message from sender

Throws:

cMsgException - if error writing file

handleSyncSendRequest

public int handleSyncSendRequest(cMsgMessageFull msg)
                          throws cMsgException

Write message to queue file.

Specified by:

handleSyncSendRequest in interface cMsgSubdomainInterface

Overrides:

handleSyncSendRequest in class cMsgSubdomainAdapter

Parameters:

msg - message from sender

Returns:

0 on success, else 1

Throws:

cMsgException - never

handleSendAndGetRequest

public void handleSendAndGetRequest(cMsgMessageFull message)
                             throws cMsgException

Returns message at head of queue.

Specified by:

handleSendAndGetRequest in interface cMsgSubdomainInterface

Overrides:

handleSendAndGetRequest in class cMsgSubdomainAdapter

Parameters:

message - message to generate sendAndGet response to (contents ignored)

Throws:

cMsgException - if error reading file or delivering message to client