|
|
The file CiscoEventGateway.idl contains the following interfaces:
CiscoEventGateway::Callback CiscoEventGateway::EventGateway
The CiscoEventGateway module defines interfaces and structures to construct a bridge between the Cisco VPN Solutions Center internal event system and the CORBA-based client applications that subscribe to them.
Since
Cisco VPN Solutions Center, Release 1.2
Sequence of primitive boolean types.
Usage
typedef sequence<boolean> BooleanSeq
Since
Cisco VPN Solutions Center, Release 1.2
Sequence of primitive double types.
Usage
typedef sequence<double> DoubleSeq
See Also
FloatSeq
Since
Cisco VPN Solutions Center, Release 1.2
Structure that describes a single event..
Usage
struct Event
{
string subject;
Msg msg;
};
Members
subject—string that represents the subject name that categorizes this event.
msg—Msg structure that collectively comprises the event message.
Description
An event contains a subject and a message with supporting data. The supporting data may be any primitive CORBA type, although the Msg structure typically contains a series of key=value pairs. In some cases, however, the value associated with the key may be a nested Msg structure.
See Also
Callback::deliverEvents
Since
Cisco VPN Solutions Center, Release 1.2
Sequence of Event structures.
Usage
typedef sequence<Event> EventSeq
See Also
Callback::deliverEvents
Since
Cisco VPN Solutions Center, Release 1.2
Sequence of primitive float types.
Usage
typedef sequence<float> FloatSeq
See Also
DoubleSeq
Since
Cisco VPN Solutions Center, Release 1.2
Sequence of primitive long long types.
Usage
typedef sequence<long long> LongLongSeq
See Also
ShortSeq, UShortSeq, LongSeq, ULongSeq, ULongLongSeq
Since
Cisco VPN Solutions Center, Release 1.2
Sequence of primitive long types.
Usage
typedef sequence<long> LongSeq
See Also
ShortSeq, UShortSeq, ULongSeq, LongLongSeq, ULongLongSeq
Since
Cisco VPN Solutions Center, Release 1.2
Structure that consists of a sequence of message parts that collectively describe an event.
Usage
struct Msg
{
MsgFieldSeq fields;
};
Members
fields—MsgFieldSeq that contains all of the message parts required to adequately describe an event.
See Also
Event
Since
Cisco VPN Solutions Center, Release 1.2
Structure that defines a part of field of an event message.
Usage
struct MsgField
{
string name;
long id;
any data;
};
Members
name—string that specifies the name of this part of the event message. Whether a name field is unique or not depends on the event type that the complete message—that is, the assembled MsgField structures—is to support.
id—long that is a unique identifier for each part of a multipart message.
data—any that represents a variant type to support whatever data is delivered by the message.
See Also
MsgFieldSeq
Since
Cisco VPN Solutions Center, Release 1.2
Sequence of MsgField structures.
Usage
typedef sequence<MsgField> MsgFieldSeq
See Also
Msg
Since
Cisco VPN Solutions Center, Release 1.2
Sequence of primitive short types.
Usage
typedef sequence<short> ShortSeq
See Also
UShortSeq, LongSeq, ULongSeq, LongLongSeq, ULongLongSeq
Since
Cisco VPN Solutions Center, Release 1.2
Sequence of primitive unsigned long long types.
Usage
typedef sequence<unsigned long long> ULongLongSeq
See Also
ShortSeq, UShortSeq, LongSeq, ULongSeq, LongLongSeq
Since
Cisco VPN Solutions Center, Release 1.2
Sequence of primitive unsigned long types.
Usage
typedef sequence<unsigned long> ULongSeq
See Also
ShortSeq, UShortSeq, LongSeq, LongLongSeq, ULongLongSeq
Since
Cisco VPN Solutions Center, Release 1.2
Sequence of primitive unsigned short types.
Usage
typedef sequence<unsigned short> UShortSeq
See Also
ShortSeq, LongSeq, ULongSeq, LongLongSeq, ULongLongSeq
Since
Cisco VPN Solutions Center, Release 1.2
Indicates that an EventGateway object could not register a specified Callback object with the Event Gateway server.
Usage
exception FailedRegistration
{
string description;
};
Parameters
description—Describes why the registration failed.
Since
Cisco VPN Solutions Center, Release 1.2
Indicates that the unique Callback-object identifier was not valid was a valid ID value on the Event Gateway server.
Usage
exception InvalidCallbackId
{
string callbackId;
};
Parameters
callbackId—Represents the invalid Callback-object identifier
Since
Cisco VPN Solutions Center, Release 1.2
An instance of the Callback interface represents a client-side callback mechanism that can be registered and subject-subscribed by a CiscoEventGateway::EventGateway object to accept delivery of events from event queue of the Event Gateway server.
See Also
EventGateway, EventGateway::registerCallback, EventGateway::reregisterCallback, EventGateway::deregisterCallback, EventGateway::beginDelivery, EventGateway::endDelivery
Since
Cisco VPN Solutions Center, Release 1.2
Executes on the client for a registered Callback object upon receipt of notification by the Event Gateway server that one or more events are queued for delivery to it.
Usage
void deliverEvents(in EventSeq events);
Parameters
events—in EventSeq in which the client stores any events it receives from the Event Gatway server.
See Also
Event, EventGateway::beginDelivery, EventGateway::endDelivery
Since
Cisco VPN Solutions Center, Release 1.2
An instance of the EventGateway interface bridges the communication of events between the Event Gateway server that executes as part of the Cisco VPN Solutions Center software and a CiscoEventGateway::Callback object in a CORBA client application. With an EventGateway object your client appication can register and deregister CiscoEventGateway::Callback objects with the Event Gateway server. With a registered CiscoEventGateway::Callback object, your client can subscribe and unsubscribe it with the specific subjects used by the Event Gateway server to categorize the events that are reported to it.
See Also
Callback
Since
Cisco VPN Solutions Center, Release 1.2
Begin delivery of events of a specified subject category to a specified Callback object.
Usage
void beginDelivery(in string callbackId, in string subject)
raises(InvalidCallbackId, FailedRegistration);
Parameters
callbackId—in string that corresponds with the unique identifier on the Event Gateway server for the Callback object to which event notifications are to be delivered. This the return value from execution of the registerCallback() operation when originally registering the Callback object with the Event Gateway server. Retrieve this value from your persistent storage location.
subject — in string that specifies the subject for which events are to be queued for delivery to the Callback object specified by the callbackId value.
Raises
InvalidCallbackId if the specifed callbackId value is not recognized as a valid identifier by the Event Gateway server. FailedRegistration if the Event Gateway server is unable to begin delivering events. This may be caused by a resource problem.
Description
If beginDelivery is executed multiple times with the callbackId and subject values, the extra executions are quietly ignored.
See Also
endDelivery
Since
Cisco VPN Solutions Center, Release 1.2
Degisters a CiscoEventGateway::Callback object with the Event Gateway server when event notification is no longer needed for a specified Callback object.
Usage
void deregisterCallback(in string callbackId)
raises(InvalidCallbackId);
Parameters
callbackId—in string that corresponds with the unique identifier on the Event Gateway server for the Callback object to be deregistered. This the return value from execution of the registerCallback() operation when originally registering the Callback object with the Event Gateway server. Retrieve this value from your persistent storage location.
Raises
InvalidCallbackId if the specifed callbackId value is not recognized as a valid identifier by the Event Gateway server.
See Also
registerCallback, reregisterCallback
Since
Cisco VPN Solutions Center, Release 1.2
End delivery of events of a specified subject category to a specified Callback object.
Usage
void endDelivery(in string callbackId, in string subject)
raises(InvalidCallbackId);
Parameters
callbackId—in string that corresponds with the unique identifier on the Event Gateway server for the Callback object to which event notifications are to be terminated. This is the return value from execution of the registerCallback() operation when originally registering the Callback object with the Event Gateway server. Retrieve this value from your persistent storage location.
subject — in string that specifies the subject for which events are to be terminated for the Callback object specified by the callbackId value.
Raises
InvalidCallbackId if the specifed callbackId value is not recognized as a valid identifier by the Event Gateway server.
See Also
beginDelivery
Since
Cisco VPN Solutions Center, Release 1.2
Registers a CiscoEventGateway::Callback object with the Event Gateway server.
Usage
string registerCallback(in Callback callbackObject, in long timeoutValue)
raises(FailedRegistration);
Parameters
callbackObject—in Callback that specifies the client object to notify when events arrive.
timeoutValue—in long that specifies the number of seconds to wait after contact is lost with the callback before deleting all subscriptions for the callback and any events that are queued for delivery.
Returns
string—Identifier by which the Event Gateway server uniquely identifies the registered CiscoEventGateway::Callback object. Construct a persistent storage mechanism for values returned by this operation to add persistence to your Callback object registration.
Raises
FailedRegistration if the specified callbackObject is not successfully registered with the Event Gateway server.
See Also
reregisterCallback, deregisterCallback
Since
Cisco VPN Solutions Center, Release 1.2
Reregisters a CiscoEventGateway::Callback object with the Event Gateway server upon restarting the client.
Usage
void reregisterCallback(in string callbackId, in Callback callbackObject, in long timeoutValue)
raises(InvalidCallbackId, FailedRegistration);
Parameters
callbackId—in string that corresponds with the unique identifier on the Event Gateway server for the Callback object to be reregistered. This the return value from execution of the registerCallback() operation when originally registering the Callback object with the Event Gateway server. Retrieve this value from your persistent storage location.
callbackObject—in Callback that specifies the client object to notify when events arrive.
timeoutValue—in long that specifies the number of seconds to wait after contact is lost with the callback before deleting all subscriptions for the callback and any events that are queued for delivery.
Raises
InvalidCallbackId if the specifed callbackId value is not recognized as a valid identifier by the Event Gateway server. FailedRegistration if the specified callbackObject is not successfully reregistered with the Event Gateway server.
See Also
registerCallback, deregisterCallback
Since
Cisco VPN Solutions Center, Release 1.2
Posted: Tue Sep 26 16:46:27 PDT 2000
Copyright 1989-2000©Cisco Systems Inc.