J-Sim v1.2.1-p7 API

drcl.inet.socket
Class SocketApplication

java.lang.Object
  extended bydrcl.DrclObj
      extended bydrcl.comp.Component
          extended bydrcl.inet.socket.SocketApplication
All Implemented Interfaces:
java.lang.Cloneable, NonblockingSocketHandler, ObjectDuplicable, java.io.Serializable

public class SocketApplication
extends Component
implements NonblockingSocketHandler

Application base class for using InetSocket. Subclasses must call super.process(Object, Port) to delegate incoming data to opened sockets.

See Also:
Serialized Form

Nested Class Summary
 
Nested classes inherited from class drcl.comp.Component
Component.Locks
 
Field Summary
protected  SocketMaster socketMaster
           
 
Fields inherited from class drcl.comp.Component
FLAG_COMPONENT_NOTIFICATION, FLAG_DEBUG_ENABLED, FLAG_DIRECT_OUTPUT_ENABLED, FLAG_ENABLED, FLAG_ERROR_ENABLED, FLAG_EVENT_ENABLED, FLAG_EXPOSED, FLAG_GARBAGE_DISPLAY_ENABLED, FLAG_GARBAGE_ENABLED, FLAG_HAS_EXPOSED_CHILD, FLAG_PORT_NOTIFICATION, FLAG_STARTED, FLAG_STOPPED, FLAG_TRACE_ENABLED, FLAG_UNDEFINED_START, id, infoPort, locks, name, parent, PortGroup_DEFAULT_GROUP, PortGroup_EVENT, PortGroup_SERVICE, Root, Trace_DATA, Trace_SEND
 
Constructor Summary
SocketApplication()
           
SocketApplication(java.lang.String id_)
           
 
Method Summary
 void acceptFinished(InetSocket serverSocket_, InetSocket new_)
          Called back when accepting a new connection is finished.
 void closeFinished(InetSocket socket_)
          Called back when a connection is closed.
 void connectFinished(InetSocket socket_)
          Called back when a connection is established.
 void error(InetSocket socket_, java.io.IOException error_)
          Called back when an error occurs during "accept" or "connect".
 java.lang.String info()
          Returns information regarding this component.
 boolean isMultiSessionEnabled()
           
protected  void process(java.lang.Object data_, Port inPort_)
          The main callback method of a component.
 void reset()
          Resets the component for being used anew.
 void setMultiSessionEnabled(boolean enabled_)
           
 
Methods inherited from class drcl.comp.Component
_resume, _start, _stop, addComponent, addComponent, addEventPort, addEventPort, addForkPort, addPort, addPort, addPort, addPort, addPort, addPort, addPort, addPort, addServerPort, addServerPort, cancelFork, componentAdded, componentRemoved, connect, containsComponent, containsComponent, containsPort, debug, disconnectAll, disconnectAllPeers, disconnectAllPorts, drop, drop, duplicate, error, error, expose, exposeEventPorts, exposePort, exposePort, exposePort, exposePort, exposePort, findAvailable, findAvailable, findAvailable, finishing, fork, forkAt, getAllComponents, getAllPorts, getAllPorts, getAllWiresInside, getAllWiresInsideOut, getAllWiresOut, getComponent, getComponentFlag, getComponentFlag, getContract, getContractHT, getContractHT, getDebugFlagsInBinary, getDebugLevelNames, getForkManager, getID, getName, getParent, getPort, getPort, getRoot, getRuntime, getTime, iduplicate, isAncestorOf, isComponentNotificationEnabled, isContainer, isDebugEnabled, isDebugEnabledAt, isDirectlyRelatedTo, isDirectOutputEnabled, isEnabled, isErrorNoticeEnabled, isEventExportEnabled, isGarbageDisplayEnabled, isGarbageEnabled, isPortNotificationEnabled, isPortRemovable, isStarted, isStopped, isTraceEnabled, lock, notify, notifyAll, operate, portAdded, portRemoved, reboot, removeAll, removeAllComponents, removeAllPorts, removeAllPorts, removeComponent, removeComponent, removePort, removePort, removePort, resume, run, sduplicate, send, sendAt, setComponentFlag, setComponentFlag, setComponentNotificationEnabled, setContract, setDebugEnabled, setDebugEnabled, setDebugEnabledAt, setDebugEnabledAt, setDebugEnabledAt, setDirectOutputEnabled, setDirectOutputEnabled, setEnabled, setErrorNoticeEnabled, setErrorNoticeEnabled, setEventExportEnabled, setEventExportEnabled, setExecutionBoundary, setGarbageDisplayEnabled, setGarbageDisplayEnabled, setGarbageEnabled, setGarbageEnabled, setID, setID, setName, setPort, setPort, setPortNotificationEnabled, setPortRemovable, setRuntime, setTraceEnabled, setTraceEnabled, sleepFor, sleepUntil, stop, toString, unexpose, unlock, useLocalForkManager, useLocalForkManager, wait, yield
 
Methods inherited from class drcl.DrclObj
clone
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

socketMaster

protected SocketMaster socketMaster
Constructor Detail

SocketApplication

public SocketApplication()

SocketApplication

public SocketApplication(java.lang.String id_)
Method Detail

reset

public void reset()
Description copied from class: Component
Resets the component for being used anew. All the internal variables must be set to the initial state. All the ports and child components are reset as well.

Overrides:
reset in class Component

info

public java.lang.String info()
Description copied from class: Component
Returns information regarding this component. Subclasses should override this method to provide useful information at run time.

Overrides:
info in class Component

isMultiSessionEnabled

public boolean isMultiSessionEnabled()

setMultiSessionEnabled

public void setMultiSessionEnabled(boolean enabled_)

acceptFinished

public void acceptFinished(InetSocket serverSocket_,
                           InetSocket new_)
Called back when accepting a new connection is finished. Override this only when nonblocking "accept" is used.

Specified by:
acceptFinished in interface NonblockingSocketHandler
Parameters:
serverSocket_ - where the accepting occurred.
new_ - socket for the new connection.

connectFinished

public void connectFinished(InetSocket socket_)
Called back when a connection is established. Override this only when nonblocking "connect" is used.

Specified by:
connectFinished in interface NonblockingSocketHandler
Parameters:
socket_ - where the connection is established.

closeFinished

public void closeFinished(InetSocket socket_)
Called back when a connection is closed. Override this only when nonblocking "close" is used.

Specified by:
closeFinished in interface NonblockingSocketHandler
Parameters:
socket_ - where the connection is closed.

error

public void error(InetSocket socket_,
                  java.io.IOException error_)
Called back when an error occurs during "accept" or "connect". Override this only when nonblocking "accept"/"connect" is used.

Specified by:
error in interface NonblockingSocketHandler
Parameters:
socket_ - to which the error is related.
error_ - the error message.

process

protected void process(java.lang.Object data_,
                       Port inPort_)
Description copied from class: Component
The main callback method of a component. Being invoked when data arrives at a port of its.

Overrides:
process in class Component
Parameters:
data_ - the arrival data.
inPort_ - the port where the data arrives.

J-Sim v1.2.1-p7 API

Copyright © 1998-2003 Distributed Real-time Computing Lab (DRCL). All Rights Reserved.     ~ To J-Sim Home ~