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

JavaTM SCTP API
DRAFT ea-b09

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)
          Indicates whether some other object is "equal to" this one.
 int hashCode()
          Returns a hash code value for the object.
 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 the object.
 
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()
Description copied from class: java.lang.Object
Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object. The result should be a concise but informative representation that is easy for a person to read. It is recommended that all subclasses override this method.

The toString method for class Object returns a string consisting of the name of the class of which the object is an instance, the at-sign character `@', and the unsigned hexadecimal representation of the hash code of the object. In other words, this method returns a string equal to the value of:

 getClass().getName() + '@' + Integer.toHexString(hashCode())
 

Overrides:
toString in class Object
Returns:
a string representation of the object.

equals

public boolean equals(Object obj)
Description copied from class: java.lang.Object
Indicates whether some other object is "equal to" this one.

The equals method implements an equivalence relation on non-null object references:

The equals method for class Object implements the most discriminating possible equivalence relation on objects; that is, for any non-null reference values x and y, this method returns true if and only if x and y refer to the same object (x == y has the value true).

Note that it is generally necessary to override the hashCode method whenever this method is overridden, so as to maintain the general contract for the hashCode method, which states that equal objects must have equal hash codes.

Overrides:
equals in class Object
Parameters:
obj - the reference object with which to compare.
Returns:
true if this object is the same as the obj argument; false otherwise.
See Also:
Object.hashCode(), Hashtable

hashCode

public int hashCode()
Description copied from class: java.lang.Object
Returns a hash code value for the object. This method is supported for the benefit of hashtables such as those provided by java.util.Hashtable.

The general contract of hashCode is:

As much as is reasonably practical, the hashCode method defined by class Object does return distinct integers for distinct objects. (This is typically implemented by converting the internal address of the object into an integer, but this implementation technique is not required by the JavaTM programming language.)

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

JavaTM SCTP API
DRAFT ea-b09