Package acpAdapter


Detailed Description

CORBA-based plug-in API that allows you to pass information to ACP in any language that supports CORBA.


Classes

union  AttributeUnion
 Structure used to pass attribute types to ACP. More...
struct  TagValue
 List of attributes in TagValue format. More...
interface  RemoteUpdateInterface
 Remote update interface. More...

Typedefs

typedef sequence< TagValueTagValueList
 Attributes are passed to the update() method in the form of a TagValue list.

Enumerations

enum  RemoteUpdateType {
  PE_USER,
  PE_CONGESTIONPOINT
}
 Types of information that the application is updating. More...
enum  CongestionPointState {
  CP_UP,
  CP_DOWN
}
 Congestion point state indicates whether the interface is up or down. More...
enum  RemoteUpdateAttribute {
  RU_LOGIN_NAME,
  RU_PHONE,
  RU_INTF_NAME,
  RU_INTF_DN,
  RU_NETWORK_DEVICE,
  RU_INTF_STATE,
  RU_UPSTREAM_SYNC_RATE,
  RU_DOWNSTREAM_SYNC_RATE,
  RU_TIME_STAMP,
  RU_PORT_ID,
  RU_NAS_IP,
  RU_USER_IP_ADDRESS,
  RU_NAS_INET_ADDRESS,
  RU_USER_INET_ADDRESS,
  RU_ROUTER_TYPE,
  RU_last
}
 Plug-in attributes that the application can pass to ACP. More...
enum  RemoteUpdateAttributeType {
  PAT_LONG_LONG,
  PAT_LONG,
  PAT_STRING,
  PAT_STATE,
  PAT_OPAQUE
}
 Possible encoding types of attribute types. More...


Typedef Documentation

typedef sequence<TagValue> acpAdapter.TagValueList

Attributes are passed to the update() method in the form of a TagValue list.


Enumeration Type Documentation

enum acpAdapter::RemoteUpdateType

Types of information that the application is updating.

The information type is passed as the first argument in the update() method.

Enumerator:
PE_USER  Subscriber information.
PE_CONGESTIONPOINT  Congestion point information.

enum acpAdapter::CongestionPointState

Congestion point state indicates whether the interface is up or down.

Enumerator:
CP_UP  Interface is up.
CP_DOWN  Interface is down.

enum acpAdapter::RemoteUpdateAttribute

Plug-in attributes that the application can pass to ACP.

Enumerator:
RU_LOGIN_NAME  Subscriber's login name specified as a string, such as jane@isp1.com.
RU_PHONE  Telephone number specified as a string.
RU_INTF_NAME  Interface name specified as a string, such as fastEthernet 3/1.2.
RU_INTF_DN  DN of the backbone congestion point provisioned in the LDAP directory specified as a string.
RU_NETWORK_DEVICE  Virtual router name specified as a string.
RU_INTF_STATE  Congestion point state, whether interface is in up or down state.
RU_UPSTREAM_SYNC_RATE  Upstream bandwidth specified as 32-bit integer value.
RU_DOWNSTREAM_SYNC_RATE  Downstream bandwidth specified as 32-bit integer value.
RU_TIME_STAMP  Timestamp in milliseconds specified as 64-bit integer value.
RU_PORT_ID  NAS port ID specified as a string.
RU_NAS_IP  NAS IP address specified as 32-bit integer value.
RU_USER_IP_ADDRESS  User IP address specified as 32-bit integer value.
RU_NAS_INET_ADDRESS 
RU_USER_INET_ADDRESS  NAS IP address in InetAddress.
RU_ROUTER_TYPE  User IP address in InetAddress.
RU_last  type of the router

enum acpAdapter::RemoteUpdateAttributeType

Possible encoding types of attribute types.

Enumerator:
PAT_LONG_LONG  64-bit integer
PAT_LONG  32-bit integer
PAT_STRING  character string
PAT_STATE  CP_UP or CP_DOWN.
PAT_OPAQUE  Byte array.


Generated on Wed May 8 13:28:20 2013 for API for Admission Control Plug-In (ACP) by  doxygen 1.4.7