MqContextC_Proxy_RB_API

MqContextC - copy data from the read-data-package of the sourceCtx to the send-data-package of the targetCtx More...

Collaboration diagram for MqContextC_Proxy_RB_API:

Functions
static OT_ProcRet	rbmqmsgque_MqContextC_ProxyForward (MqContextC_ARGS)
	Ruby: sourceCtx.ProxyForward(targetCtx:MqContextC, ?dump:MqDumpC=nil?, ?timeout:MkTimeoutE|int32=DEFAULT?) → C-API send the entire read-data-package-data to the link-target …
static OT_ProcRet	rbmqmsgque_MqContextC_ProxyItem (MqContextC_ARGS)
	Ruby: sourceCtx.ProxyItem(targetCtx:MqContextC) → C-API Copy a single-data-item from the sourceCtx to the targetCtx.

Detailed Description

MqContextC - copy data from the read-data-package of the sourceCtx to the send-data-package of the targetCtx

The proxy-feature is used in a filter-setup to process-and-forward incoming data.

See also

MqDumpC

Example: A typical proxy-setup in pseudo C++ code

void myService () {
  MqContextC *ftr = SlaveGetFilter();     // get the "slave" with id "1" (the filter)
  ...
  ftr->SendSTART();                       // start the FORWARD
  while (ReadItemExists()) {              // read ALL data from the ORIGINAL service-call
    ProxyItem(ftr);                       // forward a SINGEL item from "this" to "ftr"
  }
  ...
  ftr->SendEND_AND_WAIT("MYTK");          // send the data.package to "ftr"
  ...
  SendSTART();                            // start the ANSWER
  while (ftr->ReadItemExists()) {         // read ALL data from the "MYTK" service-call
    ftr->ProxyItem(this);                 // forward a SINGEL item from "ftr" to "this"
  }
  SendRETURN();                           // answer the ORIGINAL service call
}

Function Documentation

rbmqmsgque_MqContextC_ProxyForward()

static OT_ProcRet rbmqmsgque_MqContextC_ProxyForward ( MqContextC_ARGS )

static

Ruby: sourceCtx.ProxyForward(targetCtx:MqContextC, ?dump:MqDumpC=nil?, ?timeout:MkTimeoutE|int32=DEFAULT?) → C-API
send the entire read-data-package-data to the link-target …

Definition at line 1586 of file MqContextC_rb.c.

                                                                {
  OT_SETUP_hdl;
  OT_SETUP_VARARGS(1,3,ProxyForward_doc);
  MQ_CTX targetCtx = 0;
  OT_CHECK_REQUIRED(OT_CHECK_CTX (targetCtx,MK_NULL_NO))
  MQ_DMP dump = NULL;
  OT_CHECK_OPTIONAL(OT_CHECK_DMP (dump,MK_NULL_YES))
  MK_TIME_T timeout = MK_TIMEOUT_DEFAULT;
  OT_CHECK_OPTIONAL(OT_CHECK_TIME_T (timeout))
  OT_CHECK_NOARGS;
  MkErrorC_Check(hdl,MqProxyForward (hdl, targetCtx, dump, timeout));
  OT_retObj_SET_None;
  end: MK_UNUSED  /* LONG JUMP on error */
  OT_retObj_RETURN;
}

rbmqmsgque_MqContextC_ProxyItem()

static OT_ProcRet rbmqmsgque_MqContextC_ProxyItem ( MqContextC_ARGS )

static

Ruby: sourceCtx.ProxyItem(targetCtx:MqContextC) → C-API
Copy a single-data-item from the sourceCtx to the targetCtx.

Definition at line 1603 of file MqContextC_rb.c.

                                                             {
  OT_SETUP_hdl;
  OT_SETUP_ONEARG(ProxyItem_doc);
  MQ_CTX targetCtx = 0;
  OT_CHECK_REQUIRED(OT_CHECK_CTX (targetCtx,MK_NULL_NO))
  OT_CHECK_NOARGS;
  MkErrorC_Check(hdl,MqProxyItem (hdl, targetCtx));
  OT_retObj_SET_None;
  end: MK_UNUSED  /* LONG JUMP on error */
  OT_retObj_RETURN;
}