cosnotifyfilter.idl

这是广泛使用的通信开源项目,对于大容量,高并发的通讯要求完全能够胜任,他广泛可用于网络游戏医学图像网关的高qos要求.更详细的内容可阅读相应的材料

     *   tested against the constraints in this Filter
     * @return TRUE if at least one constraint evaluates to TRUE for
     *   the event.
     * @throws UnsupportedFilterableData if the event contents do not
     *    match the filtering expression, for example, if the
     *    expression for a filterable field expects a string, but the
     *    actual value is a number.
     */
    boolean match ( in any filterable_data )
      raises (UnsupportedFilterableData);

    /// Match a structured event against the constraints in the filter
    /**
     * @param filterable_data The Notification Service event to be
     *   tested against the constraints in this Filter
     * @return TRUE if at least one constraint expression evaluates
     *   to TRUE for the event.
     * @throws UnsupportedFilterableData if the event contents do not
     *    match the filtering expression, for example, if the
     *    expression for a filterable field expects a string, but the
     *    actual value is a number.
     */
    boolean match_structured (
                in CosNotification::StructuredEvent filterable_data )
      raises (UnsupportedFilterableData);

    /// Match a typed event against the constraints in the filter
    /**
     * @param filterable_data The sequence of properties that make the
     *   filterable portion of the Typed event.
     * @return TRUE if at least one constraint expression evaluates
     *   to TRUE for the event.
     * @throws UnsupportedFilterableData if the event contents do not
     *    match the filtering expression, for example, if the
     *    expression for a filterable field expects a string, but the
     *    actual value is a number.
     */
    boolean match_typed (
                in CosNotification::PropertySeq filterable_data )
      raises (UnsupportedFilterableData);

    /// Add a callback interface to the filter
    /**
     * Filters can communicate changes in the list of event types they
     * potentially accept.
     *
     * @param callback the object interested about changes in the
     *   Filter event type list.
     * @return A unique ID attached to the callback interface.
     */
    CallbackID attach_callback (
                   in CosNotifyComm::NotifySubscribe callback);

    /// Remove a callback interface from the filter
    /**
     * @param callback The ID of the callback removed
     *
     * @throws CallbackNotFound if the callback id supplied is not
     *   found in the internal list of callbacks.
     */
    void detach_callback ( in CallbackID callback)
      raises ( CallbackNotFound );

    /// Return all the callback IDs in the Filter object
    CallbackIDSeq get_callbacks();
  };

  /**
   * @interface MappingFilter
   *
   * @brief Mapping filters can be used to change properties of an
   *   event as it traverses the Notification Service.
   */
  interface MappingFilter {
    /// Return the constraint grammar used in the mapping filter
    readonly attribute string constraint_grammar;

    /// Return the type code for the property affected by this mapping
    /// filter
    readonly attribute CORBA::TypeCode value_type;

    /// Return the default value set by this mapping filter
    /**
     * The default value is used if there are no mapping constraint
     * expressions matching the event.
     */
    readonly attribute any default_value;

    /// Add multiple mapping constraints to the filter
    /**
     * @param pair_list List of constraint expressions and the
     *   corresponding property value
     *
     * @return The list of constraint expressions, their values, and
     *   the IDs assigned to them in this Filter.
     *
     * @throws InvalidConstraint if one or more constraint expressions
     *   do not match the constraint grammar of this mapping filter
     * @throws InvalidValue if the value in one or more mapping
     *   constraint pairs does not match the type code for this
     *   mapping filter.
     */
    MappingConstraintInfoSeq add_mapping_constraints (
                                in MappingConstraintPairSeq pair_list)
        raises (InvalidConstraint, InvalidValue);

    /// Modify and/or remove mapping constraints in the filter
    /**
     * @param del_list list of constraint IDs that should be removed
     * @param modify_list list of constraints that would be modified
     *
     * @throws InvalidConstraint if one or more constraint expressions
     *   do not match the constraint grammar of this mapping filter
     * @throws InvalidValue if the value in one or more mapping
     *   constraint pairs does not match the type code for this
     *   mapping filter.
     * @throws ConstraintNotFound if one or more mapping constraint
     *   IDs are not found in the filter
     */
    void modify_mapping_constraints (
             in ConstraintIDSeq del_list,
             in MappingConstraintInfoSeq modify_list)
      raises (InvalidConstraint, InvalidValue, ConstraintNotFound);

    /// Retrieve multiple mapping constraints from the filter
    /**
     * @param id_list the list of mapping constraint IDs requested
     * @return The list of constraint expressions, their values and
     *   IDs.
     * @throws ConstraintNotFound if one or more mapping constraint
     *   IDs are not found in the filter
     */
    MappingConstraintInfoSeq get_mapping_constraints (
                                 in ConstraintIDSeq id_list)
      raises (ConstraintNotFound);

    /// Get all the mapping constraints from the Filter
    MappingConstraintInfoSeq get_all_mapping_constraints();

    /// Remove all the mapping constraints in the Filter
    void remove_all_mapping_constraints();

    /// Destroy the mapping filter
    void destroy();

    /// Test an event against the mapping constraints
      boolean match ( in any filterable_data,
                      out any result_to_set )
        raises (UnsupportedFilterableData);

      boolean match_structured (
                  in CosNotification::StructuredEvent filterable_data,
                  out any result_to_set)
        raises (UnsupportedFilterableData);

      boolean match_typed (
                  in CosNotification::PropertySeq filterable_data,
                  out any result_to_set)
        raises (UnsupportedFilterableData);
  };

  /**
   * @interface FilterFactory
   *
   * @brief Create Filter and MappingFilter objects
   */
  interface FilterFactory {
    /// Create a new Filter object
    /**
     * @param constraint_grammar The name of the grammar used for this
     *   filter
     * @throws InvalidGrammar The grammar name provided is invalid or
     *   unsupported
     */
    Filter create_filter (in string constraint_grammar)
                        raises (InvalidGrammar);

    /// Create a new MappingFilter object
    /**
     * @param constraint_grammar The name of the grammar used for this
     *   filter
     * @param default_value The default property value used if no
     *   mapping constraint matches
     * @throws InvalidGrammar The grammar name provided is invalid or
     *   unsupported
     */
    MappingFilter create_mapping_filter (
                       in string constraint_grammar,
                       in any default_value)
      raises(InvalidGrammar);
  };

  /// Each filter is assigned a unique ID
  typedef long FilterID;

  /// List of filter IDs
  typedef sequence<FilterID> FilterIDSeq;

  /**
   * @exception FilterNotFound
   *
   * @brief Exception raised if a filter ID is not found.
   */
  exception FilterNotFound {};

  /**
   * @interface FilterAdmin
   *
   * @brief Interface used to modify the Filters attached to a
   *   Notification Service component
   */
  interface FilterAdmin {
    /// Add a filter
    /**
     * @param new_filter Filter to be added
     * @return The ID assigned to the new filter
     */
    FilterID add_filter ( in Filter new_filter );

    /// Remove a filter
    /**
     * @param filter ID of the filter to be removed
     * @throws FilterNotFound if the filter ID is not found in this
     *   FilterAdmin
     */
    void remove_filter ( in FilterID filter )
      raises ( FilterNotFound );

    /// Get a filter
    /**
     * @param filter ID of the filter returned
     * @return The filter
     * @throws FilterNotFound if the filter ID is not found in this
     *   FilterAdmin
     */
    Filter get_filter ( in FilterID filter )
      raises ( FilterNotFound );

    /// Get the IDs of all the filters
    /**
     * @return The list of all filter IDs in this component
     */
    FilterIDSeq get_all_filters();

    /// Remove all the filters from this component
    void remove_all_filters();
  };
};

#pragma prefix ""

#endif /* _COS_NOTIFY_FILTER_IDL_ */