All Packages  Class Hierarchy  This Package  Previous  Next  Index

Interface com.visigenic.vbroker.interceptor.ClientInterceptor

public interface ClientInterceptor

Java Class com.visigenic.vbroker.interceptor.ClientInterceptor
Source File com/visigenic/vbroker/interceptor/ClientInterceptor.java
IDL Source File interceptor.idl
IDL Absolute Name ::interceptor::ClientInterceptor
Repository Identifier IDL:visigenic.com/interceptor/ClientInterceptor:1.0

IDL definition:

interface ClientInterceptor {
void prepare_request(
inout ::GIOP::RequestHeader hdr,
in ::interceptor::Closure closure
);
::CORBA::portable::OutputStream send_request(
in ::GIOP::RequestHeader hdr,
in ::CORBA::portable::OutputStream buf,
in ::interceptor::Closure closure
);
void send_request_failed(
in ::GIOP::RequestHeader hdr,
in ::CORBA::Environment env,
in ::interceptor::Closure closure
);
void send_request_succeeded(
in ::GIOP::RequestHeader hdr,
in ::interceptor::Closure closure
);
::CORBA::portable::InputStream receive_reply(
in ::GIOP::ReplyHeader hdr,
in ::CORBA::portable::InputStream buf,
in ::CORBA::Environment env,
in ::interceptor::Closure closure
);
void receive_reply_failed(
in unsigned long req_id,
in ::CORBA::Environment env,
in ::interceptor::Closure closure
);
void exception_occurred(
in unsigned long req_id,
in ::CORBA::Environment env,
in ::interceptor::Closure closure
);
};

Client side interceptor. There is usually one client interceptor per object.

exception_occurred(int, Environment, Closure): Function called when an exception is thrown by one of the interceptors.
prepare_request(RequestHeaderHolder, Closure): Called during request prepare.
receive_reply(ReplyHeader, InputStream, Environment, Closure): Called when a reply is received.
receive_reply_failed(int, Environment, Closure): Called when receiving a reply failed.
send_request(RequestHeader, OutputStream, Closure): Called when sending the request/message If return is "non null" that buffer is sent instead of input buf.
send_request_failed(RequestHeader, Environment, Closure): Called when send failed.
send_request_succeeded(RequestHeader, Closure): Called when send succeeded.

prepare_request

 public abstract void prepare_request(RequestHeaderHolder hdr,
                                      Closure closure)

Called during request prepare. Implementations can put service contexts into hdr as appropriate

Operation: ::interceptor::ClientInterceptor::prepare_request.

void prepare_request(
inout ::GIOP::RequestHeader hdr,
in ::interceptor::Closure closure
);

Parameters:: hdr - The GIOP Request header associated with this request. The header may be changed by the interceptor during this call.; closure - A new closure object to be used for the processing of this request.

send_request

 public abstract OutputStream send_request(RequestHeader hdr,
                                           OutputStream buf,
                                           Closure closure)

Called when sending the request/message If return is "non null" that buffer is sent instead of input buf.

Operation: ::interceptor::ClientInterceptor::send_request.

::CORBA::portable::OutputStream send_request(
in ::GIOP::RequestHeader hdr,
in ::CORBA::portable::OutputStream buf,
in ::interceptor::Closure closure
);

Parameters:: hdr - The GIOP Request header associated with this request.; buf - This output stream contains all marashalled arguments associated with this request.; closure - The closure object previously passed to prepare_request.
Returns:: A new output stream to replace the one given by the ORB, or null if the ORB should use the original output stream.

send_request_failed

 public abstract void send_request_failed(RequestHeader hdr,
                                          Environment env,
                                          Closure closure)

Called when send failed. Most likely a COMM_FAILURE

Operation: ::interceptor::ClientInterceptor::send_request_failed.

void send_request_failed(
in ::GIOP::RequestHeader hdr,
in ::CORBA::Environment env,
in ::interceptor::Closure closure
);

Parameters:: hdr - the GIOP Request header associated with this request.; env - An environment object containing the exception indicating why the request failed.; closure - The closure object previously passed to prepare_request.

send_request_succeeded

 public abstract void send_request_succeeded(RequestHeader hdr,
                                             Closure closure)

Called when send succeeded.

Operation: ::interceptor::ClientInterceptor::send_request_succeeded.

void send_request_succeeded(
in ::GIOP::RequestHeader hdr,
in ::interceptor::Closure closure
);

Parameters:: hdr - the GIOP Request header associated with this request.; closure - The closure object previously passed to prepare_request.

receive_reply

 public abstract InputStream receive_reply(ReplyHeader hdr,
                                           InputStream buf,
                                           Environment env,
                                           Closure closure)

Called when a reply is received. If return value is not null, that value is passed to upcall. (Can be used for decrpyption)

Operation: ::interceptor::ClientInterceptor::receive_reply.

::CORBA::portable::InputStream receive_reply(
in ::GIOP::ReplyHeader hdr,
in ::CORBA::portable::InputStream buf,
in ::CORBA::Environment env,
in ::interceptor::Closure closure
);

Parameters:: hdr - the GIOP Request header associated with this request.; buf - An input stream containing the marshalled values of the return value and any out parameters returned from the server.; closure - The closure object previously passed to prepare_request.

receive_reply_failed

 public abstract void receive_reply_failed(int req_id,
                                           Environment env,
                                           Closure closure)

Called when receiving a reply failed. Most likely a COMM_FAILURE. If there are "user exceptions" they will be in CORBA::portable::InputStreams

Operation: ::interceptor::ClientInterceptor::receive_reply_failed.

void receive_reply_failed(
in unsigned long req_id,
in ::CORBA::Environment env,
in ::interceptor::Closure closure
);

Parameters:: req_id - The request id corresponding the request for which no reply was received.; env - An environment object containing the exception indicating why the reply failed.; closure - The closure object previously passed to prepare_request.

exception_occurred

 public abstract void exception_occurred(int req_id,
                                         Environment env,
                                         Closure closure)

Function called when an exception is thrown by one of the interceptors.

Operation: ::interceptor::ClientInterceptor::exception_occurred.

void exception_occurred(
in unsigned long req_id,
in ::CORBA::Environment env,
in ::interceptor::Closure closure
);

Parameters:: req_id - The request id corresponding the request for which no reply was received.; env - An environment object containing the exception indicating the exception which occurred.; closure - The closure object previously passed to prepare_request.

All Packages  Class Hierarchy  This Package  Previous  Next  Index