Main Page Namespace List Class Hierarchy Alphabetical List Compound List File List Namespace Members Compound Members File Members

# CosNotifyChannelAdmin Namespace Reference

Defines the interfaces to connect and manipulate the Notification Service. More...

## Compounds

struct | AdminLimit
| Helper structure to represent a violation of the limits in a proxy admin. More...
exception | AdminLimitExceeded
| Exception raised if a limit in a proxy admin is breached. More...
exception | AdminNotFound
| Exception raised if a lookup for a specific Admin ID fails. More...
exception | ChannelNotFound
| Exception raised if an specific ChannelID is not found. More...
exception | ConnectionAlreadyActive
| Exception Raised if an attempt is made to resume a connection that has not been suspended. More...
exception | ConnectionAlreadyInactive
| Exception raised if an attempt is made to suspend a connection already suspended. More...
interface | ConsumerAdmin
| Interface used to control and obtain the proxies used by consumers. More...
interface | EventChannel
| Defines the interface to control an use an event channel. More...
interface | EventChannelFactory
| Defines the interface used to build event channels. More...
exception | NotConnected
| Exception raised if an attempt is made to suspend or resume a proxy that has not been connected. More...
interface | ProxyConsumer
| Defines the interface shared by all consumer proxies. More...
exception | ProxyNotFound
| Exception raised if a lookup for a specific Proxy ID fails. More...
interface | ProxyPullConsumer
| Defines the interface provided for pull-style suppliers using the 'any' event format. More...
interface | ProxyPullSupplier
| Defines the interface provided for pull-style consumers using the 'any' event format. More...
interface | ProxyPushConsumer
| Defines the interface provided for push-style suppliers using the 'any' event format. More...
interface | ProxyPushSupplier
| Defines the interface provided for push-style consumers using the 'any' event format. More...
interface | ProxySupplier
| Defines the interface shared by all supplier proxies. More...
interface | SequenceProxyPullConsumer
| Defines the interface provided for pull-style suppliers using the 'batched' event format. More...
interface | SequenceProxyPullSupplier
| Defines the interface provided for pull-style consumer using the 'batched' event format. More...
interface | SequenceProxyPushConsumer
| Defines the interface provided for push-style suppliers using the 'batched' event format. More...
interface | SequenceProxyPushSupplier
| Defines the interface provided for push-style consumers using the 'batched' event format. More...
interface | StructuredProxyPullConsumer
| Defines the interface provided for pull-style suppliers using the 'structured' event format. More...
interface | StructuredProxyPullSupplier
| Defines the interface provided for pull-style consumers using the 'structured' event format. More...
interface | StructuredProxyPushConsumer
| Defines the interface provided for push-style suppliers using the 'structured' event format. More...
interface | StructuredProxyPushSupplier
| Defines the interface provided for push-style consumers using the 'structured' event format. More...
interface | SupplierAdmin
| Interface used to control and obtain the proxies used by suppliers. More...

## Typedefs

typedef long | ProxyID
| Each proxy is assigned a unique ID by its proxy admin.
typedef sequence< ProxyID > | ProxyIDSeq
| Helper type to query or fetch multiple IDs simulatenously.
typedef long | AdminID
| Each proxy admin is assigned a unique number by its EventChannel.
typedef sequence< AdminID > | AdminIDSeq
| List of Admin IDs.
typedef long | ChannelID
| Each event channel is assigned a unique ID by its factory.
typedef sequence< ChannelID > | ChannelIDSeq

## Enumerations

enum | ProxyType { PUSH_ANY, PULL_ANY, PUSH_STRUCTURED, PULL_STRUCTURED, PUSH_SEQUENCE, PULL_SEQUENCE, PUSH_TYPED, PULL_TYPED }
| Helper typedef to inspect the types of proxies connected to an EventChannel. More...
enum | ObtainInfoMode { ALL_NOW_UPDATES_OFF, ALL_NOW_UPDATES_ON, NONE_NOW_UPDATES_OFF, NONE_NOW_UPDATES_ON }
| Define the modes to fetch subscriptions and publication lists from the Notification Service. More...
enum | ClientType { ANY_EVENT, STRUCTURED_EVENT, SEQUENCE_EVENT }
| Helper type used to fetch proxies. More...
enum | InterFilterGroupOperator { AND_OP, OR_OP }
| Define how multiple Filters are considered in a proxy admin. More...

## Detailed Description

Defines the interfaces to connect and manipulate the Notification Service.

## Typedef Documentation

typedef long CosNotifyChannelAdmin::AdminID

| Each proxy admin is assigned a unique number by its EventChannel.

typedef sequence<AdminID> CosNotifyChannelAdmin::AdminIDSeq

| List of Admin IDs.

typedef long CosNotifyChannelAdmin::ChannelID

| Each event channel is assigned a unique ID by its factory.

typedef sequence<ChannelID> CosNotifyChannelAdmin::ChannelIDSeq

| Helper type used to return the complete list of event channel IDs

typedef long CosNotifyChannelAdmin::ProxyID

| Each proxy is assigned a unique ID by its proxy admin.

typedef sequence<ProxyID> CosNotifyChannelAdmin::ProxyIDSeq

| Helper type to query or fetch multiple IDs simulatenously.

## Enumeration Type Documentation

enum CosNotifyChannelAdmin::ClientType

Helper type used to fetch proxies.

Enumeration values:

  ANY_EVENT | The proxy uses the 'any' event format.
  STRUCTURED_EVENT | The proxy uses the 'structured' event format.
  SEQUENCE_EVENT | The proxy uses the 'sequence' (or batch) event format.

enum CosNotifyChannelAdmin::InterFilterGroupOperator

Define how multiple Filters are considered in a proxy admin.

Enumeration values:

  AND_OP |
  OR_OP |

enum CosNotifyChannelAdmin::ObtainInfoMode

Define the modes to fetch subscriptions and publication lists from the Notification Service.

Enumeration values:

  ALL_NOW_UPDATES_OFF | Get all the current subscriptions/publications, do not send updates to the peer
  ALL_NOW_UPDATES_ON | Get all the current subscriptions/publications, send updates to the peer
  NONE_NOW_UPDATES_OFF | Do not get any of the current subscriptions/publications, do not send updates to the peer either
  NONE_NOW_UPDATES_ON | Do not get any of the current subscriptions/publications, but send updates to the peer

enum CosNotifyChannelAdmin::ProxyType

Helper typedef to inspect the types of proxies connected to an EventChannel.

Enumeration values:

  PUSH_ANY | A push-style proxy that uses the 'any' format.
  PULL_ANY | A pull-style proxy that uses the 'any' format.
  PUSH_STRUCTURED | A push-style proxy that uses structured events.
  PULL_STRUCTURED | A pull-style proxy that uses structured events.
  PUSH_SEQUENCE | A push-style proxy that uses event batches.
  PULL_SEQUENCE | A pull-style proxy that uses event batches.
  PUSH_TYPED | A typed, push-style proxy.
  PULL_TYPED | A typed, pull-style proxy.