Please note that this documentation is not final and is subject to change.

JavaTM SCTP API
DRAFT ea-b11

com.sun.nio.sctp
Class SctpStandardSocketOption.InitMaxStreams

java.lang.Object
  extended by com.sun.nio.sctp.SctpStandardSocketOption.InitMaxStreams
Enclosing class:
SctpStandardSocketOption

public static class SctpStandardSocketOption.InitMaxStreams
extends Object

This class is used to set the maximum number of inbound/outbound streams used by the local endpoint during association initialization. An instance of this class is used to set the SCTP_INIT_MAXSTREAMS socket option.

Since:
1.7

Method Summary
static SctpStandardSocketOption.InitMaxStreams create(int maxInStreams, int maxOutStreams)
          Creates an InitMaxStreams instance.
 boolean equals(Object obj)
          Returns true if the specified object is another InitMaxStreams instance with the same number of in and out bound streams.
 int hashCode()
          Returns a hash code value for this init max streams.
 int maxInStreams()
          Returns the maximum number of inbound streams.
 int maxOutStreams()
          Returns the maximum number of outbound streams.
 String toString()
          Returns a string representation of this init max streams, including the maximum in and out bound streams.
 
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
 

Method Detail

create

public static SctpStandardSocketOption.InitMaxStreams create(int maxInStreams,
                                                             int maxOutStreams)
Creates an InitMaxStreams instance.

Parameters:
maxInStreams - The maximum number of inbound streams, where 0 <= maxInStreams <= 65536
maxOutStreams - The maximum number of outbound streams, where 0 <= maxOutStreams <= 65536
Returns:
An InitMaxStreams instance
Throws:
IllegalArgumentException - If an argument is outside of specified bounds

maxInStreams

public int maxInStreams()
Returns the maximum number of inbound streams.

Returns:
Maximum inbound streams

maxOutStreams

public int maxOutStreams()
Returns the maximum number of outbound streams.

Returns:
Maximum outbound streams

toString

public String toString()
Returns a string representation of this init max streams, including the maximum in and out bound streams.

Overrides:
toString in class Object
Returns:
A string representation of this init max streams

equals

public boolean equals(Object obj)
Returns true if the specified object is another InitMaxStreams instance with the same number of in and out bound streams.

Overrides:
equals in class Object
Parameters:
obj - The object to be compared with this init max streams
Returns:
true if the specified object is another InitMaxStreams instance with the same number of in and out bound streams
See Also:
Object.hashCode(), HashMap

hashCode

public int hashCode()
Returns a hash code value for this init max streams.

Overrides:
hashCode in class Object
Returns:
a hash code value for this object.
See Also:
Object.equals(java.lang.Object), System.identityHashCode(java.lang.Object)

JavaTM SCTP API
DRAFT ea-b11