Package com.newstep.solid.comm

 
Subpackages Summary
management 
rtt 
tcp 
udp 
utils 

 
Package Diagram Summary
comm 

 
Sequence Diagram Summary
Client channel creation sequence 
Server Channel creation sequence 
 
Object Summary
Unknown Name 
Unknown Name 
Unknown Name 
Unknown Name 

 
Class Summary
AbstractChannel 
ChannelAccessPoint 
ChannelAccessPointFactory 
ChannelException 
ChannelFactory 
Connections 
IPAddress 
Message 
Multiplexor 
ProtocolElement 

 
Enumeration Summary
ChannelState 

 
Package Summary
management 
rtt 
tcp 
udp 
utils 
Package Elements Detail
AbstractChannel
 

 
Activation Summary
Activation2 
Activation3 
Activation1 

 
Dependency Link Summary
Unknown Name 

 
Message Link Summary
Unknown Name 

 
Messages Link Summary
Unknown Name 

Activation1
 

Activation2
 

Activation3
 

Unknown Name
 

Unknown Name
 

Unknown Name
 

 
Dependency Link Summary
Unknown Name 

Unknown Name
 

Address
Marker that signals that a particluar address type can be used by a Multiplexor to monitor IO operations
Author:
atomus
 

 
Operation Summary
parseString 
toString 

parseString
 
Abstract.
Throws:
ChannelException
 

 
Parameter Summary
return 
string 

return
 

string
 

toString
 
Abstract.
 

 
Parameter Summary
return 

return
 

Channel
Provides an abstraction for a communications channel.
Channel clients may exchange information by reading and writing messags on the channel.
Channel reading is passive (via ChannelListener.onMessage()).
The channel interface may be implemented by concrete transport protocol
wrappers/implementations (e.g. TcpChannel, UdpChannel).
Channel is the south bound interface that enables chaining of disparate protocol
functions into a single protocol.
 


addChannelStatusListener
 
Abstract.
 

 
Parameter Summary
listener 

listener
 

close
 
Abstract.
Throws:
ChannelException
 

getChannelListener
 
Abstract.
 

 
Parameter Summary
return 

return
 

getLocalAddress
 
Abstract.
 

 
Parameter Summary
return 

return
 

getRemoteAddress
 
Abstract.
 

 
Parameter Summary
return 

return
 

open
 
Abstract.
Throws:
ChannelException
 

removeChannelStatusListener
 
Abstract.
 

 
Parameter Summary
listener 

listener
 

setChannelListener
 
Abstract.
 

 
Parameter Summary
listener 

listener
 

write
 
Abstract.
Throws:
ChannelException
 

 
Parameter Summary
message 

message
 

ChannelAccessPoint
 

 
Activation Summary
Activation1 

 
Dependency Link Summary
Unknown Name 

 
Message Link Summary
Unknown Name 

 
Messages Link Summary
Unknown Name 

Activation1
 

Unknown Name
 

Unknown Name
 

 
Dependency Link Summary
Unknown Name 

Unknown Name
 

Unknown Name
 

ChannelAccessPointListener
Implementors of this interface get notified when a client connects to a listener.
 

 
Operation Summary
notify 

notify
 
Abstract.
Throws:
ChannelException
 

 
Parameter Summary
channel 

channel
 

ChannelFactory
 

 
Activation Summary
Activation1 

 
Dependency Link Summary
Unknown Name 

 
Message Link Summary
new 

 
Messages Link Summary
Unknown Name 

Activation1
 

new
 

Unknown Name
 

Unknown Name
 

ChannelListener
Interface provides the contract between Channels and their passive listening clients.
ChannelListener represents a client that waits passively for messages on the channel
 

 
Operation Summary
onMessage 

onMessage
 
Abstract.
 

 
Parameter Summary
message 

message
 

ChannelState
The possibles states of a channel
Full name:
com.newstep.solid.comm.ChannelState
Public.
Visibility:
public
 

 
Enumeration Literal Summary
CLOSED 
ERROR 
IDLE 
OPEN 

CLOSED
Visibility:
package
 

ERROR
Visibility:
package
 

IDLE
Visibility:
package
 

OPEN
Visibility:
package
 

ChannelStatusListener
Represents entity that is interested in Channel status changes.
Once an enity that implements ChannelStatusListener registers with a Channel,
it is notified of any change in the channel state.
 

 
Operation Summary
statusChangedInterface that specifies the contract for a status listener.

statusChanged
 
Interface that specifies the contract for a status listener.
Abstract.
 

 
Parameter Summary
channel 
state 

channel
 

state
 

ChannelStatusListener
 

IOHandler
An entity that handles the IO operations for a channel
Author:
atomus
 

 
Operation Summary
getInterestedOpsReturns the operations an IOHandler is interested in
onAcceptOP_ACCEPT ready
onClosedcallback for closed channel
onConnectOP_CONNECT ready
onDonecallback for selector closed
onReadOP_READ ready
onWriteOP_WRITE ready

getInterestedOps
 
Returns the operations an IOHandler is interested in
Return:
int
Abstract.
 

 
Parameter Summary
return 

return
 

onAccept
 
OP_ACCEPT ready
Parameters:
key SelectionKey
Abstract.
Throws:
ChannelException
 

 
Parameter Summary
key 

key
 

onClosed
 
callback for closed channel
Parameters:
channel SelectableChannel
Abstract.
 

 
Parameter Summary
channel 

channel
 

onConnect
 
OP_CONNECT ready
Abstract.
Throws:
ChannelException
 

onDone
 
callback for selector closed
Abstract.
 

onRead
 
OP_READ ready
Parameters:
key SelectionKey
Abstract.
Throws:
ChannelException
 

 
Parameter Summary
key 

key
 

onWrite
 
OP_WRITE ready
Abstract.
Throws:
ChannelException
 

 
Parameter Summary
key 

key
 

Multiplexor
 

 
Activation Summary
Activation1 

 
Dependency Link Summary
Unknown Name 

 
Message Link Summary
Unknown Name 

Activation1
 

Unknown Name
 

Unknown Name
 

Unknown Name
 

 
Message Link Summary
Unknown Name 
Unknown Name 

 
Messages Link Summary
Unknown Name 
Unknown Name 

Unknown Name
 

 
Dependency Link Summary
Unknown Name 

Unknown Name
 

Unknown Name
 

Unknown Name
 

 
Dependency Link Summary
Unknown Name 

Unknown Name
 

Unknown Name
 

Unknown Name
 

 
Activation Summary
Activation2 

 
Dependency Link Summary
Unknown Name 

 
Message Link Summary
create 

Activation2
 

create
 

Unknown Name
 

Unknown Name
 

 
Activation Summary
Activation4 

 
Dependency Link Summary
Unknown Name 

Activation4
 

Unknown Name
 

Unknown Name
 

 
Activation Summary
Activation3 

 
Dependency Link Summary
Unknown Name 

 
Messages Link Summary
Messages Link 

Activation3
 

Messages Link
 

Unknown Name
 

User
 

 
Message Link Summary
getChannel 
Unknown Name 

 
Messages Link Summary
Unknown Name 
Unknown Name 

getChannel
 

 
Dependency Link Summary
Unknown Name 

Unknown Name
 

Unknown Name
 

Unknown Name
 

 
Dependency Link Summary
Unknown Name 

Unknown Name
 

Unknown Name