Package event


Classes

exception  UnknownRouter
 Raised when a call for a currently not managed router is received. More...
exception  IllegalArgument
 Raised when illegal arguments were passed. More...
union  AttributeUnion
 Value union of an event attribute. More...
struct  EventAttr
 A single event attribute. More...
interface  RouterListener
 A callback interface that can be implemented by a client of the event interface. More...
interface  EventNotification
 The event notification interface of SAE allows integration with external IP address managers for router drivers that do not receive address assignment events directly from the router. More...

Typedefs

typedef sequence< EventAttrEventAttrSeq
 A sequence of event attributes.
typedef sequence< EventAttrSeqEventAttrSeqSeq
 A sequence of EventAttrSeq, used in EventNofication.ipSynchronize.
typedef sequence< octet > InetAddress
 IPv4 address: 4 octet in network order.
typedef sequence< InetAddressInetAddressSeq
 A sequence of InetAddresses.

Enumerations

enum  EventAttribute {
  EA_INTERFACE_NAME,
  EA_SESSION_ID,
  EA_IF_ALIAS,
  EA_IF_DESCR,
  EA_IF_INDEX,
  EA_NAS_PORT_ID,
  EA_NAS_PORT,
  EA_NAS_IP,
  EA_RADIUS_CLASS,
  EA_SERVICE_BUNDLE,
  EA_LOGIN_NAME,
  EA_IP_ADDRESS,
  EA_IP_MASK,
  EA_MTU,
  EA_BROADCAST_ADDR,
  EA_INTERFACE_SPEED,
  EA_MAC_ADDRESS,
  EA_DHCP_PACKET,
  EA_LOGIN_TYPE,
  EA_USER_IP_ADDRESS,
  EA_INTERFACE_TYPE,
  EA_TUNNEL_SERVER_IP_ADDRESS,
  EA_TUNNEL_SERVER_IP_MASK,
  EA_TUNNEL_ID,
  EA_TUNNEL_SESSION_ID,
  EA_CALLING_STATION_ID,
  EA_LOCAL_QOS_PROFILE
}
 List of possible event attribute types that can be included in an EventNotification.ipUp call. More...
enum  EventAttributeType {
  EAT_LONG,
  EAT_LONG_LONG,
  EAT_STRING,
  EAT_OPAQUE
}
 Possible types of event attributes. More...


Typedef Documentation

typedef sequence<EventAttr> event.EventAttrSeq

A sequence of event attributes.

typedef sequence<EventAttrSeq> event.EventAttrSeqSeq

A sequence of EventAttrSeq, used in EventNofication.ipSynchronize.

typedef sequence<octet> event.InetAddress

IPv4 address: 4 octet in network order.

IPv6 address: 16 octet in network order (not yet supported).

typedef sequence<InetAddress> event.InetAddressSeq

A sequence of InetAddresses.


Enumeration Type Documentation

enum event::EventAttribute

List of possible event attribute types that can be included in an EventNotification.ipUp call.

Enumerator:
EA_INTERFACE_NAME  Name of the interface
  • Type: EAT_STRING.
EA_SESSION_ID  Session Identifier, eg RADIUS accounting session ID
  • Type: EAT_STRING.
EA_IF_ALIAS  Description of the interface
  • Type: EAT_STRING.
EA_IF_DESCR  Alternative name of the interface
  • Type: EAT_STRING.
EA_IF_INDEX  SNMP index of the interface
  • Type: EAT_LONG.
EA_NAS_PORT_ID  Port identification string
  • Type: EAT_STRING.
EA_NAS_PORT  Port identification
  • Type: EAT_LONG.
EA_NAS_IP  Router IP address
  • Type: EAT_OPAQUE (4 octet for IPv4 address).
EA_RADIUS_CLASS  Interface RADIUS class
  • Type: EAT_STRING.
EA_SERVICE_BUNDLE  Interface Service Bundle
  • Type: EAT_STRING.
EA_LOGIN_NAME  Interface login name (for authenticated interface only)
  • Type: EAT_STRING.
EA_IP_ADDRESS  Interface IP Address
  • Type: EAT_OPAQUE (4 octet for IPv4 address).

Note:
This is not the IP address of a connected user.
EA_IP_MASK  Interface network mask
  • Type: EAT_OPAQUE (4 octet for IPv4 address).
EA_MTU  Interface maximum transfer unit
  • Type: EAT_LONG.
EA_BROADCAST_ADDR  Interface broadcast address
  • Type: EAT_OPAQUE (4 octet for IPv4 address).
EA_INTERFACE_SPEED  Speed of interface in bit per second
  • Type: EAT_LONG_LONG.
EA_MAC_ADDRESS  MAC address of subscriber
  • Type: EAT_OPAQUE (6 octet).
EA_DHCP_PACKET  DHCP options from discover request
  • Type: EAT_OPAQUE
  • First 4 octet: giAddr
  • remaining octets: octets 236- of DHCP discover request.
EA_LOGIN_TYPE  Type of login request.

One of: INTF, AUTHINTF, ADDR, AUTHADDR; defaults to ADDR

  • Type: EAT_STRING
EA_USER_IP_ADDRESS  IP address of the user session associated with the event
  • Type: EAT_OPAQUE (4 octet for IPv4 address).

Note:
This attribute should only be sent to EventNotification.ipSynchronize and is ignored by EventNotification.ipUp.
EA_INTERFACE_TYPE  Type of interface, IPV4, IPV6, L2TP (default=IP)
  • Type: EAT_STRING.
EA_TUNNEL_SERVER_IP_ADDRESS  The L2TP tunnel server IP address
  • Type: EAT_OPAQUE (4 octet for IPv4 address).
EA_TUNNEL_SERVER_IP_MASK  The L2TP tunnel server IP mask
  • Type: EAT_LONG (network prefix length).
EA_TUNNEL_ID  The L2TP tunnel ID
  • Type: EAT_LONG.
EA_TUNNEL_SESSION_ID  The L2TP tunnel session ID
  • Type: EAT_LONG.
EA_CALLING_STATION_ID  The Calling-Station-Id associated with the interface
  • Type: EAT_STRING.
EA_LOCAL_QOS_PROFILE  The local qos profiles associated with the interface
  • Type: EAT_STRING.

enum event::EventAttributeType

Possible types of event attributes.

Enumerator:
EAT_LONG  32 bit signed integer
EAT_LONG_LONG  64 bit signed integer
EAT_STRING  character string
EAT_OPAQUE  byte array


Generated on Tue May 24 14:55:27 2011 for SAE API by  doxygen 1.4.7