org.mbari.siam.distributed
Interface ShoreMessaging

All Superinterfaces:

java.rmi.Remote, RemoteService

All Known Implementing Classes:

A3LAMessagingService, NAL9601MessagingService, NALMessagingService, ShoreMessagingService, SimulatedShoreMessagingService

public interface ShoreMessaging
extends RemoteService

Service interface for shore messaging facility.

Author:

Tom O'Reilly

Method Summary

void	connect(int timeoutSec) Connect modem to shore, attempt to downlink queued messages
int	maxDownlinkMsgBytes() Return maximum bytes allowed in a downlink message
int	nQueuedDownlinkMsgs() Return number of messages currently in downlink queue
int	queueDownlinkMessage(byte[] message) Queue a message for downlink; returns current number of messages in queue.
void	shutdown() Shutdown service

Methods inherited from interface org.mbari.siam.distributed.RemoteService

ping

Method Detail

maxDownlinkMsgBytes

int maxDownlinkMsgBytes()
                        throws java.rmi.RemoteException

Return maximum bytes allowed in a downlink message

Throws:

java.rmi.RemoteException

queueDownlinkMessage

int queueDownlinkMessage(byte[] message)
                         throws ShoreMessagingHelper.MessageTooBig,
                                java.lang.Exception,
                                java.rmi.RemoteException

Queue a message for downlink; returns current number of messages in queue.

Throws:

ShoreMessagingHelper.MessageTooBig

java.lang.Exception

java.rmi.RemoteException

nQueuedDownlinkMsgs

int nQueuedDownlinkMsgs()
                        throws java.rmi.RemoteException

Return number of messages currently in downlink queue

Throws:

java.rmi.RemoteException

connect

void connect(int timeoutSec)
             throws ShoreMessagingHelper.ConnectFailed,
                    java.rmi.RemoteException

Connect modem to shore, attempt to downlink queued messages

Throws:

ShoreMessagingHelper.ConnectFailed

java.rmi.RemoteException

shutdown

void shutdown()
              throws java.rmi.RemoteException

Shutdown service

Throws:

java.rmi.RemoteException