Class
Tree
          
SUMMARY: INNER | FIELD | CONSTR | METHODDETAIL: FIELD | CONSTR | METHOD
  
com.newstep.solid.netio.slip
Class SlipAccessPointConfig
com.newstep.solid.netio.management.ChannelAccessPointConfig
  |
  +--com.newstep.solid.netio.slip.SlipAccessPointConfig
public class SlipAccessPointConfig      
The configuration required to initialize the SlipAccessPoint.


NOTE: the SlipAccessPointConfig MUST contain transport protocol
access point config such that it can assign a valid transport to the Slip
protocol stack.

 
Links:
Kernel Association Association Link
to Class ChannelAccessPointConfig
The configuration for the underlying slip transport protocol
Associates type:
association
Client cardinality:
1
Client navigability:
NOT NAVIGABLE
Client visibility:
private
Supplier cardinality:
1
Supplier navigability:
NAVIGABLE
Supplier visibility:
private
 
Generalization Generalization Link
to Class ChannelAccessPointConfig
The configuration required to initialize the SlipAccessPoint.


NOTE: the SlipAccessPointConfig MUST contain transport protocol
access point config such that it can assign a valid transport to the Slip
protocol stack.

 
 
Field Summary
int
int
LengthEncoding
private final static int
private final static LengthEncoding
private final static int
int
LengthEncoding
int
Constructor Summary
public void
SlipAccessPointConfig(ChannelAccessPointConfig transAccessPointConfig, Integer headerPadding, Integer maxPayloadSize, LengthEncoding lengthEncoding)
public void
Method Summary
public int
public LengthEncoding
public int
public void
setEncodingMax(LengthEncoding lengthEncoding, Integer maxPayloadSize)
public void
setHeaderPadding(Integer headerPadding)
public void
public String
Field Detail
DEFAULT_HEADER_PADDING
private final static int DEFAULT_HEADER_PADDING
Final.
Multiplicity:
1
Static.
 
DEFAULT_LENGTH_ENCODING
private final static LengthEncoding DEFAULT_LENGTH_ENCODING
Final.
Multiplicity:
1
Static.
 
DEFAULT_MAX_PAYLOAD
private final static int DEFAULT_MAX_PAYLOAD
Final.
Multiplicity:
1
Static.
 
headerPadding
int headerPadding
The number of blank (zero filled) byted to pad at the end of the header
Multiplicity:
1
 
headerPadding
int headerPadding
The number of blank (zero filled) byted to pad at the end of the header
 
lengthEncoding
LengthEncoding lengthEncoding
The type of encoding applied to the slip message protocol.


Valid encodings are:




NOTE: values greater than those represented by signed integer are
not supported by the buffer allocation system and therefor not by the
SLIP protocol.

 
lengthEncoding
LengthEncoding lengthEncoding
The type of encoding applied to the slip message protocol.


Valid encodings are:




NOTE: values greater than those represented by signed integer are
not supported by the buffer allocation system and therefor not by the
SLIP protocol.

Multiplicity:
1
 
maxPayload
int maxPayload
The maximum payload length. This must be valid based on the encoding
mechanism. E.g. a maxPayload of 65535 will is NOT valid with the BYTE
encoding scheme.
 
maxPayload
int maxPayload
The maximum payload length. This must be valid based on the encoding
mechanism. E.g. a maxPayload of 65535 will is NOT valid with the BYTE
encoding scheme.
Multiplicity:
1
 
transAccessPointConfig
private ChannelAccessPointConfig transAccessPointConfig
The configuration for the underlying slip transport protocol
Multiplicity:
1
 
Constructor Detail
SlipAccessPointConfig
public void SlipAccessPointConfig (ChannelAccessPointConfig transAccessPointConfig, Integer headerPadding, Integer maxPayloadSize, LengthEncoding lengthEncoding)
 
Assigns the SLIP access point factory name.
Takes parameters for the other accesspoint options.
Parameters:
transAccessPointConfig The configuraton for the transport access
point. This configuration determines the underlying protocol overwhich
the Slip protocol will function.


NOTE:The transport access point MUST support the StreamChannel construct in
order to be compatible with the SlipChannel
headerPadding The non negative number of blank bytes with which the header should be padded.
lengthEncoding The non null lengthEncoding scheme.
maxPayloadSize The maxPayload length (in bytes) for a valid SLIP message.
Must be representable in the length encoding given.

Stereotype:
create
 
SlipAccessPointConfig
public void SlipAccessPointConfig ()
 
Default constructor.
Assigns the SLIP access point factory name.
Uses default values for the config.
Stereotype:
create
 
Method Detail
getHeaderPadding
public int getHeaderPadding ()
 
Gets the number of blank bytes with which the header should be padded
Return:
The number of blank bytes with which the header should be padded.
 
getLengthEncoding
public LengthEncoding getLengthEncoding ()
 
Gets the lengthEncoding scheme enumerator
Return:
The lengthEncoding scheme enumerator
 
getMaxPayload
public int getMaxPayload ()
 
Gets the maxPayload length (in bytes) for a valid SLIP message
Return:
The maxPayload length (in bytes) for a valid SLIP message
 
getTransportAccessPointConfig
public ChannelAccessPointConfig getTransportAccessPointConfig ()
 
Gets the access point config for the SLIP protocol transport layer
Return:
The access point config for the SLIP protocol transport layer
 
setEncodingMax
public void setEncodingMax (LengthEncoding lengthEncoding, Integer maxPayloadSize)
 
Assigns the lengthEncoding scheme and the length (in bytes) for a valid SLIP message.
The given length encoding must be valid for the given max payload size.
The max payload size must be a positive number representable in the encoding type.
Parameters:
lengthEncoding The non null lengthEncoding scheme.
maxPayloadSize The maxPayload length (in bytes) for a valid SLIP message.
 
setHeaderPadding
public void setHeaderPadding (Integer headerPadding)
 
Assigns the number of blank bytes with which the header should be padded
Parameters:
headerPadding The non negative number of blank bytes with which the header should be padded.
 
setTransportAccessPointConfig
public void setTransportAccessPointConfig (ChannelAccessPointConfig transAccessPointConfig)
 
Assigns the transport access point configuration.
Parameters:
transAccessPointConfig The configuraton for the transport access
point. This configuration determines the underlying protocol overwhich
the Slip protocol will function.


NOTE:The transport access point MUST support the StreamChannel construct in
order to be compatible with the SlipChannel

 
toString
public String toString ()
 
Gets the stringified configuration values
Return:
The stringified configuration values
 
Class
Tree
          
SUMMARY: INNER | FIELD | CONSTR | METHODDETAIL: FIELD | CONSTR | METHOD