Package com.newstep.solid.netio

 
Subpackages Summary
packet 
test 

 
Subpackages Summary
management 
niowrapper 
rtt 
slip 
tcp 

 
Class Diagram Summary
Channel Hierarchy 

 
Package Diagram Summary
netio 
 
Class Summary
AbstractCommChannel 
AbstractMessageChannel 
AbstractStreamChannel 
AccessPoint 
AccessPointFactory 
ChannelEndpoint 
ProtocolElement 

 
Enumeration Summary
CommChannelState 

 
Package Summary
management 
niowrapper 
packet 
rtt 
slip 
tcp 
test 
Package Elements Detail
CommChannel
 


close
 
Abstract.
 

getLocalEndpoint
 
Abstract.
 

 
Parameter Summary
return 

return
 

getRemoteEndpoint
 
Abstract.
 

 
Parameter Summary
return 

return
 

getState
 
Abstract.
 

 
Parameter Summary
return 

return
 

setStateListener
 
Abstract.
 

 
Parameter Summary
listener 
return 

listener
 

return
 

CommChannelListener
 

CommChannelState
Full name:
com.newstep.solid.netio.CommChannelState
Public.
Visibility:
public
 

 
Enumeration Literal Summary
CLOSED 
CONNECTED 
CREATED 
ERROR 
OPEN 

CLOSED
Visibility:
package
 

CONNECTED
Visibility:
package
 

CREATED
Visibility:
package
 

ERROR
Visibility:
package
 

OPEN
Visibility:
package
 

CommChannelStateListener
 

 
Operation Summary
stateChanged 

stateChanged
 
Parameters:
newState
Abstract.
 

 
Parameter Summary
newState 

newState
 

ConnectionListener
 

 
Operation Summary
newConnection 

newConnection
 
Abstract.
 

 
Parameter Summary
channel 

channel
 

MessageChannel
Provides atomic operations, and manages data storage internaly.
 
Links:
Generalization Generalization Link
to Interface CommChannel
Provides atomic operations, and manages data storage internaly.
 

 
Generalization Summary
Generalization LinkProvides atomic operations, and manages data storage internaly.

 
Operation Summary
setMessageListenerSets the listener to receive messages from the MessageChannel
writeWrites payload data bytes to the channel as a properly formated message as defined by the protocol implemnted by
the MessageChannel

Generalization Link
Provides atomic operations, and manages data storage internaly.
 

setMessageListener
 
Sets the listener to receive messages from the MessageChannel
Parameters:
listener
receives messageReceived notification when a full message has been received
Abstract.
 

 
Parameter Summary
listener 

listener
 

write
 
Writes payload data bytes to the channel as a properly formated message as defined by the protocol implemnted by
the MessageChannel
Parameters:
payLoad
Abstract.
Throws:
IOException
 

 
Parameter Summary
payLoad 

payLoad
 

MessageListener
 
Links:
Generalization Generalization Link
to Interface CommChannelListener
 

 
Generalization Summary
Generalization Link 

 
Operation Summary
messageReceivedReceives message data from a MessageChannel

Generalization Link
 

messageReceived
 
Receives message data from a MessageChannel
Parameters:
message data (payload) bytes extracted from the specific protocol message
Abstract.
 

 
Parameter Summary
message 

message
 

ProtocolListener
 

 
Operation Summary
messageReceived 

messageReceived
 
Abstract.
 

 
Parameter Summary
message 

message
 

ProtocolMessage
 

Stream
 

 
Operation Summary
readReads a sequence of bytes into a buffer. An attempt is made to read up to r bytes from the stream, where r is the
number of bytes remaining in the buffer, that is, data.remaining(), at the moment this method is invoked.
readPerforms a scattering read of a sequence of bytes into an array of buffers. An invocation of this method attempts
to read up to r bytes from this stream, where r is the total number of bytes remaining in the specified buffer
array, that is, data[0].remaining() + data[1].remaining() + ... + data[data.length-1].remaining() at the moment
that this method is invoked. Th
setStreamListenerSets the listener to receive read notifications from the stream
writePerforms a gathering write of a sequence of bytes to this stream from the given buffers. An attempt is made to
write up to r bytes to this stream, where r is the total number of bytes remaining in the specified buffer array,
that is, payLoad[0].remaining() + payLoad[1].remaining() + ... + payLoad[payLoad.length-1].remaining() at the
moment that this method is invoked.
writeWrites a sequence of bytes to this stream from the given buffer. An attempt is made to write up to r bytes to the
stream, where r is the number of bytes remaining in the buffer, that is, payLoad.remaining(), at the moment this
method is invoked.

read
 
Reads a sequence of bytes into a buffer. An attempt is made to read up to r bytes from the stream, where r is the
number of bytes remaining in the buffer, that is, data.remaining(), at the moment this method is invoked.
Parameters:
data
The ByteBuffer to receive the data
Return:
number of bytes read from the stream or -1 if the stream was closed on the other end
Abstract.
Throws:
IOException
 

 
Parameter Summary
data 
return 

data
 

return
 

read
 
Performs a scattering read of a sequence of bytes into an array of buffers. An invocation of this method attempts
to read up to r bytes from this stream, where r is the total number of bytes remaining in the specified buffer
array, that is, data[0].remaining() + data[1].remaining() + ... + data[data.length-1].remaining() at the moment
that this method is invoked. Th
Parameters:
data
The ByteBuffers to receive the data
Return:
number of bytes read from the stream or -1 if the stream was closed on the other end
Abstract.
Throws:
IOException
 

 
Parameter Summary
data 
return 

data
 

return
 

setStreamListener
 
Sets the listener to receive read notifications from the stream
Parameters:
listener
receives readNotify messages from the stream. readNotify method is invoked by the stream whenever
there are data available for reading after the listener has been registered with the stream. The read
operation may be performed either from within the readNotify() implementation (in the same thread) or
the read may be just scheduled to be performed from another thread. The listener will not be notified
again until it reads all the available data from the stream and after that new data becomes available.
Abstract.
 

 
Parameter Summary
listener 

listener
 

write
 
Performs a gathering write of a sequence of bytes to this stream from the given buffers. An attempt is made to
write up to r bytes to this stream, where r is the total number of bytes remaining in the specified buffer array,
that is, payLoad[0].remaining() + payLoad[1].remaining() + ... + payLoad[payLoad.length-1].remaining() at the
moment that this method is invoked.
Parameters:
payLoad
The buffers from which bytes are to be retrieved
Abstract.
Throws:
IOException
 

 
Parameter Summary
payLoad 

payLoad
 

write
 
Writes a sequence of bytes to this stream from the given buffer. An attempt is made to write up to r bytes to the
stream, where r is the number of bytes remaining in the buffer, that is, payLoad.remaining(), at the moment this
method is invoked.
Parameters:
payLoad
The buffer from which bytes are to be retrieved
Abstract.
Throws:
IOException
 

 
Parameter Summary
payLoad 

payLoad
 

StreamChannel
 
Links:
Generalization Generalization Link
to Interface Stream
 
Generalization Generalization Link
to Interface CommChannel
 

 
Generalization Summary
Generalization Link 
Generalization Link 

Generalization Link
 

Generalization Link
 

StreamListener
 
Links:
Generalization Generalization Link
to Interface CommChannelListener
 

 
Generalization Summary
Generalization Link 

 
Operation Summary
readNotifyThis method is invoked by the stream whenever there are data available for reading after the listener has been
registered with the stream. The read operation may be performed either from within the readNotify()
implementation (in the same thread) or the read may be just scheduled to be performed from another thread. The
listener will not be notified again until it reads all the available data from the stream and after that new data
becomes available.

Generalization Link
 

readNotify
 
This method is invoked by the stream whenever there are data available for reading after the listener has been
registered with the stream. The read operation may be performed either from within the readNotify()
implementation (in the same thread) or the read may be just scheduled to be performed from another thread. The
listener will not be notified again until it reads all the available data from the stream and after that new data
becomes available.
Abstract.