Event Sinks

An Event Sink provides a collection of event methods that your server can use to propagate events back to the clients. In essence, Event Sinks are services that work "backwards", allowing your client to implement the defined operations and the server to call them.

To create a service, select Edit|New|Event Sink or click the Event Sink button on the Toolbar.

Selecting the Event Sink in the Library Panel will load the details into the Details Panel. In the Details Panel you can assign a name to the event sink, inherit the event sink from an existing one by specifying the Ancestor or write documentation for it.

Adding and Removing Events (Methods)

In the Operations section of the Details Panel you can define the events, or callback-methods, of your event sink. To define a new event, click the + Add Event button above the Events table. To remove an event, click the - button. Finally to name or rename an event, select the event in the events table and type the new name.

Change the order of the events with the Up/Down buttons, or the Ctrl+Up and Ctrl+Down keyboard shortcuts.

You can also provide documentation for your events by selecting the individual items and clicking the Document this Event button. This will bring up the Documentation Editor, where you can type your description.

Adding and Removing Parameters (Arguments) for an Event

You can add arguments by clicking the + Add Parameter button above the arguments table, or remove them by clicking the - button.

Because Events are one-way calls from the Server to the client, the only supported Flag type is in.

Change the order of the parameters with the Up/Down buttons, or the Ctrl+Up and Ctrl+Down keyboard shortcuts.

You can also provide documentation for your parameters by selecting the individual items and clicking the Document this Parameter button. This will bring up the Documentation Editor, where you can type your description.

See Also