MqContextC_ReadApi_RB_API

MqContextC - extract data from an incoming read-data-package … More...

Collaboration diagram for MqContextC_ReadApi_RB_API:

Topics
	MqContextC_ReadApi_Atom_RB_API
	MqContextC - read a single-data-item outof a read-data-package …
	MqContextC_ReadApi_Block_RB_API
	MqContextC - read a block-of-data outof a read-data-package …
	MqContextC_ReadApi_Misc_RB_API
	MqContextC - various functions to work on a read-data-package …

Functions
OT_ProcRet	rbmqmsgque_MqContextC_ReadNEXT (MqContextC_ARGS)
	Ruby: obj ctx.ReadNEXT() → C-API get the next argument as native object …
OT_ProcRet	rbmqmsgque_MqContextC_ReadLIST (MqContextC_ARGS)
	Ruby: [list...] ctx.ReadLIST() → C-API get all arguments as native list …

Detailed Description

MqContextC - extract data from an incoming read-data-package …

A data-package is read in two different scenarios:

• on a server to serve an incoming service-call from the client
• on a client to process the return-data from a previous service-call

Reading data is a passive-task and the opposite of sending data, which is an active-task. Passive means that the reading process is triggered by an incoming-data-package and not by the software workflow or by the user.
There is a read function and some help functions for each basic type defined in MkBufferC .

Read-Safe

Each service-call has a private read-data-package. This means that during a service-call that is in progress, another service-call can be served without damaging the read-data-package of the current service-call.

Type-Safe

A data-item in a read-data-package is type safe, this mean that every read of a data-item have to match the data-type of the previous write. One exception is available, the cast from and to the string data-type (TYPE=C) is allowed.

Example from server.rb → read-safety: Make a nested service-call

  def CSV1

    # read the input-data from the CSV1-service-call
    # client → server
    inI = ReadI32() + 1

    # call the CSV2-service at the client, wait 10sec for timeout
    # server → client → server
    retI = Send("Wt", 10, "CSV2:I@I", inI) + 1

    # answer the CSV1-service-call with the result from the CSV2-service-call
    # server → client
    Send("R", "I", retI)
  end

Function Documentation

rbmqmsgque_MqContextC_ReadLIST()

OT_ProcRet rbmqmsgque_MqContextC_ReadLIST

(

MqContextC_ARGS

)

Ruby: [list...] ctx.ReadLIST() → C-API
get all arguments as native list …

Definition at line 17 of file MqContextC_ReadLIST_lng.h.

                                                     {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(ReadLIST_doc);
  OT_CHECK_NOARGS;
  OT_retObj_SET_List;
  OT_OBJ_T RET = OT_LNG_NULL;
  MK_BUF buf = NULL;
  while (MqReadItemExists(hdl)) {
    MqReadBUF (hdl, &buf);
    switch (buf->var.type) {
      case MK_I8T:  { RET = OT_TMP_I8_OBJ(MkBuf2I8(buf)); break; }
      case MK_BOLT: { RET = OT_TMP_BOL_OBJ(MkBuf2BOL(buf)); break; }
      case MK_I16T: { RET = OT_TMP_I16_OBJ(MkBuf2I16(buf)); break; }
      case MK_I32T: { RET = OT_TMP_I32_OBJ(MkBuf2I32(buf)); break; }
      case MK_FLTT: { RET = OT_TMP_FLT_OBJ(MkBuf2FLT(buf)); break; }
      case MK_I64T: { RET = OT_TMP_I64_OBJ(MkBuf2I64(buf)); break; }
      case MK_DBLT: { RET = OT_TMP_DBL_OBJ(MkBuf2DBL(buf)); break; }
      case MK_BINT: { RET = OT_TMP_BIN_OBJ(buf->storage.first.B,buf->var.cursize); break; }
      case MK_STRT: { RET = OT_TMP_STR_OBJ(buf->storage.first.C); break; }
      case MK_LSTT: {
        MK_BFL bfl = MkBufferListCreate(5);
        MkErrorC_Check(hdl,MkBufferGetBFL (buf, &bfl));
        OT_MK_CALL_0(bfl,MkBufferListC,ToList,RET);
        MkRefDecr_X(bfl);
        break;
      }
/*
      case MQ_ROUT:
      case MQ_LTRT: {
        OT_ERROR_TYPE("unable to convert an 'internal' object into a 'public' object");
        RET = OT_LNG_NULL;
      }
*/
    }
    if (RET == OT_LNG_NULL) goto error;
    OT_retObj_APPEND(RET);
  }
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}

rbmqmsgque_MqContextC_ReadNEXT()

OT_ProcRet rbmqmsgque_MqContextC_ReadNEXT

(

MqContextC_ARGS

)

Ruby: obj ctx.ReadNEXT() → C-API
get the next argument as native object …

Method definition

Definition at line 18 of file MqContextC_ReadNEXT_lng.h.

                                                     {
  OT_SETUP_hdl
  OT_SETUP_NOARG(ReadNEXT_doc)
  OT_CHECK_NOARGS
  OT_OBJ_T RET = OT_LNG_NULL;
  MK_BUF buf = NULL;
  MqReadBUF_E(hdl, &buf);
  switch (buf->var.type) {
    case MK_I8T: { RET = OT_TMP_I8_OBJ(MkBuf2I8(buf)); break; }
    case MK_BOLT: { RET = OT_TMP_BOL_OBJ(MkBuf2BOL(buf)); break; }
    case MK_I16T: { RET = OT_TMP_I16_OBJ(MkBuf2I16(buf)); break; }
    case MK_I32T: { RET = OT_TMP_I32_OBJ(MkBuf2I32(buf)); break; }
    case MK_FLTT: { RET = OT_TMP_FLT_OBJ(MkBuf2FLT(buf)); break; }
    case MK_I64T: { RET = OT_TMP_I64_OBJ(MkBuf2I64(buf)); break; }
    case MK_DBLT: { RET = OT_TMP_DBL_OBJ(MkBuf2DBL(buf)); break; }
    case MK_BINT: { RET = OT_TMP_BIN_OBJ(buf->storage.first.B,buf->var.cursize); break; }
    case MK_STRT: { RET = OT_TMP_STR_OBJ(buf->storage.first.C); break; }
    case MK_LSTT: {
      MK_BFL bfl = MkBufferListCreate(5);
      MkErrorC_Check(hdl,MkBufferGetBFL (buf, &bfl));
      OT_MK_CALL_0(bfl,MkBufferListC,ToList,RET);
      MkRefDecr_X(bfl);
      break;
    }
/*
    case MQ_ROUT:
    case MQ_LTRT: {
      OT_ERROR_TYPE("unable to convert an 'internal' object into a 'public' object");
      RET = OT_LNG_NULL;
    }
*/
  }
  if (RET == OT_LNG_NULL) goto error;
  OT_retObj_SET(RET);
  goto end;
  error:
  OT_retObj_SET_Error;
  end:
  OT_retObj_RETURN;
}