[Previous] [Contents] [Next] [IONA Technologies]

CORBA.Filter

Contents

CORBA.Filter.Filter()
CORBA.Filter.Filter()
CORBA.Filter._delete()
CORBA.Filter.inReplyFailure()
CORBA.Filter.inReplyPostMarshal()
CORBA.Filter.inReplyPreMarshal()
CORBA.Filter.inRequestPostMarshal()
CORBA.Filter.inRequestPreMarshal()
CORBA.Filter.outReplyFailure()
CORBA.Filter.outReplyPostMarshal()
CORBA.Filter.outReplyPreMarshal()
CORBA.Filter.outRequestPostMarshal()
CORBA.Filter.outRequestPreMarshal()


Synopsis:

 Class Filter is a conceptually abstract class which describes the interface to a per-process filter.

A programmer who wishes to implement a per-process filter may define a derived class of Filter and redefine some or all of the four monitoring methods as described in Chapter 21, "Filters" of the OrbixWeb Programming Guide.

OrbixWeb:

Notes:

 OrbixWeb specific.

See Also:


CORBA.Filter.Filter()

Synopsis:

Description:

 The default constructor adds the newly created filter object into the per-process filter chain. Direct instances of Filter cannot be created: the constructor is protected to enforce this. The derived classes of Filter will normally have public constructors.

Notes:

OrbixWeb specific.


CORBA.Filter.Filter()

Synopsis:

Description:

 If the value of installme is true, this constructor adds the newly created filter object into the per-process filter chain. Direct instances of Filter cannot be created: the constructor is protected to enforce this. The derived classes of Filter may have public constructors which override this constructor.

Notes:

OrbixWeb specific.


CORBA.Filter._delete()

Synopsis:

Description:

 Removes the Filter object from the process filter chain.

Notes:

OrbixWeb specific.


CORBA.Filter.inReplyFailure()

Synopsis:

Description:

 Defines the action to carry out if the target object raises an exception or if any preceding marshalling filter point (`out request', `in request', `out reply' or `in reply') raises an exception or uses its return value to indicate that the call should not be processed any further.

If not redefined in a derived class, this filter point carries out no actions.

Notes:

OrbixWeb specific.


CORBA.Filter.inReplyPostMarshal()

Synopsis:

Description:

 Defines the action to carry out after any operation on any object in another address space; in particular, after the operation response has arrived at the caller's address space and after the operation's return parameters and return value have been removed from the reply packet.

If not redefined in a derived class, the following implementation is inherited:

Return Value:

 

     true
Continue with the request as normal. The reply is sent to the next filter on the chain, or if this is the last filter then it is sent to the calling object.

     false
Do not continue with the call. Reply immediately to the calling object; do not run the remaining filters.

Exceptions:

A programmer redefining this method in a derived class may raise an exception (and return false) to indicate that the call is not to be continued. If the return value is false, and no exception is raised, OrbixWeb raises a FILTER_SUPPRESS exception.

Notes:

OrbixWeb specific.


CORBA.Filter.inReplyPreMarshal()

Synopsis:

Description:

 Defines the action to carry out after any operation on any object in another address space; in particular after the operation response has arrived at the caller's address space and before the operation's return parameters and return value have been removed from the reply packet.

If not redefined in a derived class, the following implementation is inherited:

Return Value:

true Continue with the request as normal. The reply is sent to the next filter on the chain, or if this is the last filter then it is sent to the calling object.

false Do not continue with the call. Reply immediately to the calling object; do not run the remaining filters.

Exceptions:

A programmer redefining this method in a derived class may raise an exception (and return false) to indicate that the call is not to be continued. If the return value is false, and no exception is raised, OrbixWeb raises a FILTER_SUPPRESS exception.

Notes:

OrbixWeb specific.


CORBA.Filter.inRequestPostMarshal()

Synopsis:

Description:

 Defines the action to carry out before any incoming operation on any object in the address space; in particular, before the operation has been sent to the target object and after the operation's parameters have been removed from the request packet.

If not redefined in a derived class, the following implementation is inherited:

Return Value:

 

     true
Continue with the request as normal. The operation call is sent to the next filter on the chain, or, if this is the last filter, then it is sent to the per-object filters, if any, and then to the target object.

     false
Do not continue with the call. Reply immediately to the caller's address space; do not send the invocation to the target object; do not run the remaining filters.

Exceptions:

A programmer redefining this method in a derived class may raise an exception (and return false) to indicate that the call is not to be continued. If the return value is false, and no exception is raised, OrbixWeb raises a FILTER_SUPPRESS exception. The exception is not propagated by OrbixWeb to the caller: at this stage, the invocation is already completed and it is too late to raise an exception.

Notes:

OrbixWeb specific.


CORBA.Filter.inRequestPreMarshal()

Synopsis:

Description:

 Defines the action to carry out before incoming requests: before any incoming operation on any object in the address space; in particular, before the operation has been sent to the target object and before the operation's parameters have been removed from the request packet.

If not redefined in a derived class, the following implementation is inherited:

Return Value:

 

     true
Continue with the request as normal. The operation call is sent to the next filter on the chain, or if this is the last filter then it is sent to (the per-object filters and then to) the target object.

     false
Do not continue with the call. Reply immediately to the caller's address space (where it will be handled by `in reply' filters); do not run the remaining filters. To indicate that this has occurred, it is recommended that the filter raise an exception for the request.

Exceptions:

A programmer redefining this method in a derived class may raise an exception (and return false) to indicate that the call is not to be continued. If the return value is false, and no exception is raised, OrbixWeb raises a FILTER_SUPPRESS exception.

Notes:

OrbixWeb specific.

See Also:


CORBA.Filter.outReplyFailure()

Synopsis:

Description:

 Defines the action to carry out if the target object raises an exception or if any preceding filter point (`in request' or `out reply') raises an exception or uses its return value to indicate that the call should not be processed any further.

If not redefined in a derived class, this filter point carries out no actions.

Notes:

OrbixWeb specific.


CORBA.Filter.outReplyPostMarshal()

Synopsis:

Description:

 Defines the action to carry out before outgoing replies: after any incoming operation on any object in the address space; in particular after the operation call has been processed, and after the operation's return parameters and return value have been added to the reply packet.

If not redefined in a derived class, the following implementation is inherited:

Return Value:

 

     true
Continue with the request as normal. The reply is sent to the next filter on the chain, or if this is the last filter then it is sent to the calling object's address space (where it will be handled by `in reply' filters).

     false
Do not continue with the call. Reply immediately to the calling object's address space; do not run the remaining filters.

Exceptions:

A programmer redefining this method in a derived class may raise an exception (and return false) to indicate that the call is not to be continued. If the return value is false, and no exception is raised, OrbixWeb raises a FILTER_SUPPRESS exception.

Notes:

OrbixWeb specific.


CORBA.Filter.outReplyPreMarshal()

Synopsis:

Description:

 Defines the action to carry out before outgoing replies: after any incoming operation on any object in the address space; in particular, after the operation call has been processed and before the operation's return parameters and return value have been added to the reply packet.

If not redefined in a derived class, the following implementation is inherited:

Return Value:

true

 Continue with the request as normal. The reply is sent to the next filter on the chain, or, if this is the last filter, then it is sent to the calling object's address space (where it will be handled by `in reply' filters).

false

 Do not continue with the call. Reply immediately to the calling object's address space; do not run the remaining filters.

Exceptions:

A programmer redefining this method in a derived class may raise an exception (and return false) to indicate that the call is not to be continued. If the return value is false, and no exception is raised, OrbixWeb raises a FILTER_SUPPRESS exception.

Notes:

OrbixWeb specific.


CORBA.Filter.outRequestPostMarshal()

Synopsis:

Description:

 Defines the action to carry out before outgoing requests: before any operation from this address space to any object in another address space; in particular, before the invocation has been transmitted and after the operation's parameters have been added to the request packet.

If not redefined in a derived class, the following implementation is inherited:

Return Value:

true

 Continue with the request as normal. The operation call is sent to the next filter on the chain, or if this is the last filter then it is transmitted to the address space of the target object (where it will first be handled by any per-process filters and then per-object filters).

false

 Do not continue with the call. Reply immediately to the caller; do not send the invocation out of the caller's address space; do not run the remaining filters.

Exceptions:

A programmer redefining this method in a derived class may raise an exception (and return false) to indicate that the call is not to be continued. If the return value is false, and no exception is raised, OrbixWeb raises a FILTER_SUPPRESS exception.

Notes:

OrbixWeb specific.


CORBA.Filter.outRequestPreMarshal()

Synopsis:

Description:

 Defines the action to carry out before outgoing requests: before any operation from this address space to any object in another address space; in particular, before the invocation has been transmitted and before the operation's parameters have been added to the request packet.

If not redefined in a derived class, the following implementation is inherited:

Return Value:

true

 Continue with the request as normal. The operation call is sent to the next filter on the chain, or if this is the last filter then it is transmitted to the address space of the target object (where it will first be handled by any per-process filters and then per-object filters).

false

 Do not continue with the call. Reply immediately to the caller; do not send the invocation out of the caller's address space; do not run the remaining filters.

Exceptions:

A programmer redefining this method in a derived class may raise an exception (and return false) to indicate that the call is not to be continued. If the return value is false, and no exception is raised, OrbixWeb raises a FILTER_SUPPRESS exception.

Notes:

OrbixWeb specific.


[Roadmap] [Utilities] [Compiling] [Configuration]
[Class Reference] [IR Reference] [Daemon Reference] [IDL Grammar] [System Exceptions]
[Index]