JAINTM MGCP API (DRAFT FOR PUBLIC REVIEW) - Version 0.9 - 16 NOVEMBER 2000

jain.protocol.ip.mgcp.message.parms
Class RegularConnectionParm

java.lang.Object
  |
  +--jain.protocol.ip.mgcp.message.parms.ConnectionParm
        |
        +--jain.protocol.ip.mgcp.message.parms.RegularConnectionParm
All Implemented Interfaces:
java.io.Serializable

public class RegularConnectionParm
extends ConnectionParm
implements java.io.Serializable

Class that defines a connection parameter (e.g., number of packets sent) that is NOT an extended parameter. A connection parameter describes the status of a connection. Returned by Gateway when a connection is deleted.

See Also:
Serialized Form

Field Summary
static int JITTER
          Signifies that this ConnectionParm object represents the average inter-packet arrival jitter, in milliseconds.
static int LATENCY
          Signifies that this ConnectionParm object represents the average latency, in milliseconds.
static int OCTETS_RECEIVED
          Signifies that this ConnectionParm object represents the number of octets received.
static int OCTETS_SENT
          Signifies that this ConnectionParm object represents the number of octets sent.
static int PACKETS_LOST
          Signifies that this ConnectionParm object represents the number of packets lost.
static int PACKETS_RECEIVED
          Signifies that this ConnectionParm object represents the number of packets received.
static int PACKETS_SENT
          Signifies that this ConnectionParm object represents the number of packets sent.
 
Constructor Summary
RegularConnectionParm(int connectionParmType, int connectionParmValue)
          Constructs a new ConnectionParm object that is not an extension parameter.
 
Method Summary
 java.lang.String toString()
          Returns a String of the form "<parmName>=<parmValue>," where <parmName> is the name of the connection parameter (e.g., "PS" for "packets sent") and <parmValue> is the numeric value of the parameter.
 
Methods inherited from class jain.protocol.ip.mgcp.message.parms.ConnectionParm
getConnectionParmType, getConnectionParmValue
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

JITTER

public static int JITTER
Signifies that this ConnectionParm object represents the average inter-packet arrival jitter, in milliseconds.

LATENCY

public static int LATENCY
Signifies that this ConnectionParm object represents the average latency, in milliseconds.

OCTETS_RECEIVED

public static int OCTETS_RECEIVED
Signifies that this ConnectionParm object represents the number of octets received.

OCTETS_SENT

public static int OCTETS_SENT
Signifies that this ConnectionParm object represents the number of octets sent.

PACKETS_LOST

public static int PACKETS_LOST
Signifies that this ConnectionParm object represents the number of packets lost.

PACKETS_RECEIVED

public static int PACKETS_RECEIVED
Signifies that this ConnectionParm object represents the number of packets received.

PACKETS_SENT

public static int PACKETS_SENT
Signifies that this ConnectionParm object represents the number of packets sent.
Constructor Detail

RegularConnectionParm

public RegularConnectionParm(int connectionParmType,
                             int connectionParmValue)
                      throws java.lang.IllegalArgumentException
Constructs a new ConnectionParm object that is not an extension parameter.
Parameters:
connectionParmType - The type of the connection parameter. Must be one of the values: PACKETS_SENT; OCTETS_SENT; PACKETS_RECEIVED; OCTETS_RECEIVED; PACKETS_LOST; JITTER; or LATENCY.
connectionParmValue - The integer value of the connection parameter. Must be in the range 0-999999999.
Throws:
java.lang.IllegalArgumentException - Thrown if the type of the connection parameter is not one of the acceptable values or if the connection parameter value is outside the range 0-999999999.
Method Detail

toString

public java.lang.String toString()
Returns a String of the form "<parmName>=<parmValue>," where <parmName> is the name of the connection parameter (e.g., "PS" for "packets sent") and <parmValue> is the numeric value of the parameter.
Overrides:
toString in class java.lang.Object

JAINTM MGCP API (DRAFT FOR PUBLIC REVIEW) - Version 0.9 - 16 NOVEMBER 2000

Copyright © 2000 Sun Microsystems, Inc.