/usr/share/idl/omniEvents/omniEvents.idl is in libomnievents-dev 1:2.6.2-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 | // Package : omniEvents
// idl/omniEvents.idl Created : 2004-05-23
// Author : Alex Tingle
//
// Copyright (C) 2004 Alex Tingle.
//
// This file is part of the omniEvents application.
//
// omniEvents is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public
// License as published by the Free Software Foundation; either
// version 2.1 of the License, or (at your option) any later version.
//
// omniEvents is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public
// License along with this library; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
//
#ifndef _OMNIEVENTS_IDL_
#define _OMNIEVENTS_IDL_
#include <CosEventChannelAdmin.idl>
// =============================================================================
#pragma prefix "openorb.org"
/**
* DO NOT USE THIS MODULE UNLESS YOU ARE USING OPENORB.
* The module `openorb.org/event' is provided for compatibility with
* OpenOrb.
*/
module event
{
exception NameAlreadyUsed {};
exception EventChannelNotFound {};
interface EventChannelFactory
{
CosEventChannelAdmin::EventChannel create_channel( in string channel_name )
raises( NameAlreadyUsed );
CosEventChannelAdmin::EventChannel join_channel( in string channel_name )
raises( EventChannelNotFound );
};
};
// =============================================================================
#include <CosLifeCycle.idl>
#include "FT.idl"
#include "EventChannelAdmin.idl"
#pragma prefix "omni"
module omniEvents
{
/**
* The omniEvents event channel. Inherits the method is_alive() from
* FT::PullMonitorable.
*/
interface EventChannel:
CosEventChannelAdmin::EventChannel,
FT::PullMonitorable
{
// boolean is_alive(); <== inherited from FT::PullMonitorable
};
/**
* The omniEvents 'server'.
*
* Inherits the following methods from CosLifeCycle::GenericFactory:
* - boolean <b>supports</b>(in Key)
* - Object <b>create_object</b>(in Key, in Criteria)
*
* Key should always be {id:"EventChannel", kind:"object interface"}.
*
* <b>Valid criteria are:</b>
*
* @param PullRetryPeriod_ms [Type: unsigned long. Unit: millisecond.
* Default: 1000 (1 second)]\n
* The delay between calls to pull() made by omniEvents out
* to client's PullSupplier objects.
* @param MaxQueueLength [Type: unsigned long. Default: 1023]\n
* The number of events to store ready to sends out to Consumer
* objects. When the queue overflows, the oldest events are
* discarded first.
* @param MaxNumProxies [Type: unsigned long. Default: 1024]\n
* Limits the number of ProxyPullSuppliers that an EventChannel
* can support. When the limit is exceeded, the least active proxy
* is disconnected.
* @param CyclePeriod_ns [Type: unsigned long. Unit: nanosecond.
* Default: 100000000 (0.1 second)]\n
* Sets the cycle period of the channel. This is the time that the
* channel waits before transferring messages from the incoming
* queue to the outgoing queue. While messages are being
* transferred, incoming calls are queued. The default is 0.1
* seconds. Applications that require very rapid message delivery
* should reduce the period.
* @param InsName [Type: string. Default: None]\n
* This parameter sets the name by which the EventChannel is
* known in omniEvents INSPOA. You can then refer to the channel
* with a corbaloc string.
* @param FilterId [Type: string. Default: None]\n
* Creates a filtered event channel. The value should be a
* RepositoryId. The EventChannel silently discards all incoming
* events whose type does not match the RepositoryId.
*
* Inherits the following method from FT::PullMonitorable:
* - boolean <b>is_alive</b>()
*/
interface EventChannelFactory:
CosLifeCycle::GenericFactory,
FT::PullMonitorable,
EventChannelAdmin::EventChannelFactory,
event::EventChannelFactory
{
// == CosLifeCycle::GenericFactory ==
//
// boolean supports( in Key k );
// Object create_object( in Key k, in Criteria the_criteria )...;
// == FT::PullMonitorable ==
//
// boolean is_alive();
// == event::EventChannelFactory ==
//
// EventChannel create_channel( in string channel_name )...; *DO NOT USE*
// EventChannel join_channel( in string channel_name )...; *DO NOT USE*
};
};
#endif // _OmniEvents_idl_
|