org.safs.sockets

Interface SocketProtocolListener

All Superinterfaces:

ConnectionListener, NamedListener

All Known Implementing Classes:

RemoteControlUI, RemoteControlUI, SAFSRemoteControl, SAFSRemoteControlRunner, SoloRemoteControl, SoloRemoteControlRunner

public interface SocketProtocolListener
extends ConnectionListener

Interface definition for a local SocketProtocol Runner to receive asynchronous notification of AbstractProtocolRunner events and messages from a remote SocketProtocol Runner.

Author:

Carl Nagle, SAS Institute, Inc.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_NAME

Method Summary

Modifier and Type	Method and Description
void	onReceiveException(java.lang.String message) Remote client has thrown/issued an Exception message.
void	onReceiveMessage(java.lang.String message) Remote client has sent an arbitrary message.
void	onReceiveReady() Remote client has issued the READY event
void	onReceiveResult(int rc, java.lang.String info) Remote client has issued the RESULT event and is returning a simple statuscode and statusinfo response.
void	onReceiveResultProperties(java.util.Properties result) Remote client has issued the RESULT event and is returning result information in Properties.
void	onReceiveRunning() Remote client has issued the RUNNING event--usually resulting from a DISPATCH event.

Methods inherited from interface org.safs.sockets.ConnectionListener

onReceiveConnection, onReceiveLocalShutdown, onReceiveRemoteShutdown

Methods inherited from interface org.safs.sockets.NamedListener

getListenerName

Field Detail

DEFAULT_NAME

static final java.lang.String DEFAULT_NAME

See Also:

Constant Field Values

Method Detail

onReceiveReady

void onReceiveReady()

Remote client has issued the READY event

onReceiveRunning

void onReceiveRunning()

Remote client has issued the RUNNING event--usually resulting from a DISPATCH event.

onReceiveResult

void onReceiveResult(int rc,
                     java.lang.String info)

Remote client has issued the RESULT event and is returning a simple statuscode and statusinfo response.

Parameters:

rc - -- int statuscode

info - -- String statusinfo. Can be null. Can be an empty string.

onReceiveResultProperties

void onReceiveResultProperties(java.util.Properties result)

Remote client has issued the RESULT event and is returning result information in Properties.

Parameters:

Properties - list containing the results properties.

onReceiveException

void onReceiveException(java.lang.String message)

Remote client has thrown/issued an Exception message.

Parameters:

message -

onReceiveMessage

void onReceiveMessage(java.lang.String message)

Remote client has sent an arbitrary message. This is for custom communication between an engine and a remote client.

Parameters:

message -