MqContextC_Link_RB_API

MqContextC - setup and manage a client-server-link … More...

Collaboration diagram for MqContextC_Link_RB_API:

Functions
static OT_ProcRet	rbmqmsgque_MqContextC_LinkGetParent (MqContextC_ARGS)
	Ruby: MqContextC ctx.LinkGetParent() → C-API get the initial parent-context from a client/server link …
static OT_ProcRet	rbmqmsgque_MqContextC_LinkConnect (MqContextC_ARGS)
	Ruby: ctx.LinkConnect() → C-API re-connect a client-server-link after a server crash or a network downtime …
static OT_ProcRet	rbmqmsgque_MqContextC_LinkCreate (MqContextC_ARGS)
	Ruby: ctx.LinkCreate(?args:MkBufferListC...=nil?) → C-API make ctx to a parent-context and setup a new client-server-link …
static OT_ProcRet	rbmqmsgque_MqContextC_LinkCreateChild (MqContextC_ARGS)
	Ruby: ctx.LinkCreateChild(parent:MqContextC, ?args:MkBufferListC...=nil?) → C-API make a context to a child-context on-top of an existing parent-client-server-link …
static OT_ProcRet	rbmqmsgque_MqContextC_LinkDelete (MqContextC_ARGS)
	Ruby: ctx.LinkDelete() → C-API close the client-server-link …
static OT_ProcRet	rbmqmsgque_MqContextC_LinkGetCtxId (MqContextC_ARGS)
	Ruby: int32 ctx.LinkGetCtxId() → C-API get an identifier which is unique per parent-or-child-context …
static OT_ProcRet	rbmqmsgque_MqContextC_LinkGetTargetIdent (MqContextC_ARGS)
	Ruby: string ctx.LinkGetTargetIdent() → C-API get the ident of the link-target …
static OT_ProcRet	rbmqmsgque_MqContextC_LinkIsConnected (MqContextC_ARGS)
	Ruby: bool ctx.LinkIsConnected() → C-API is the context connected? …
static OT_ProcRet	rbmqmsgque_MqContextC_LinkIsParent (MqContextC_ARGS)
	Ruby: bool ctx.LinkIsParent() → C-API is the context a parent-context? …
static OT_ProcRet	rbmqmsgque_MqContextC_LinkShutdown (MqContextC_ARGS)
	Ruby: ctx.LinkShutdown() → C-API shutdown the communication with a server

Detailed Description

MqContextC - setup and manage a client-server-link …

The client-server-link connect two context, a client-parent-context and a server-parent-context. The link can be local (connect two context on the same host) or can be remote (connect two context on different hosts). On-Top the parent-context multiple child-context are allowed.

  !on remote host!                                  !on local host!

      server1---------x                     x----------server2
         |            |                     |             |
         |     child-context-1       child-context-2      |
         |            |                     |             |                      server
 parent-context-1-----x                     x-----parent-context-2
         |                                                |
 (MqConfigS::server)                 (example: MqConfigS::server --fork --uds … --file …)
         |                                                |
 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
         |                                                |
      (--tcp)                                  (--pipe, --uds, --tcp)
         |                                                |
 parent-context-1-----x                     x-----parent-context-2
         |            |                     |             |                      client
         |     child-context-1       child-context-2      |
         |            |                     |             |
         x------------x--------client-------x-------------x

                           !on local host!

Definition of a "client-context"

• every new client-parent-context create a new client-server-link and perform the connect system-call.
• every new client-server-link start a new server-object and creating a new server-parent-context
• every deletion of the client-parent-context stop the previous started server-object and delete the server-parent-context
• the client-context get all the error/warning/info messages from the server-context

Definition of a "server-context"

• every new server-parent-context is created by request from the client-parent-context:
• in remote mode every new server-parent-context wait for a tcp or uds connection request using the accept system-call.

client --tcp --host REMOTE_HOST --port REMOTE_PORT ...    or
client --uds --file MYFILE ...

• in local mode new server-parent-context is started by the client-parent-context as pipe:

  client @ server

  • a server-context have to implement the MqServerSetupIF and the MqFactoryC interface.
  • a server-context have to enter the event-loop and wait for incoming service-request using MqProcessEvent together with the MqWaitOnEventE.FOREVER.

Definition of a "parent-context"

• the parent is the first context created and is created with MqLinkCreate
• every new parent-context on the client create a new communication to a server.
• every new parent-context on the client connect to a new parent-context on the server
• every new parent-context on the server create a new thread or process.
• the parent-context control the socket communication interface

Definition of a "child-context"

• the child-context is the second or more context and is created with MqLinkCreateChild.
• every new child-context on the client create a new child-context on the server.
• every new child-context is totally independent from the parent-context setup and is able to serve its own services.
• the child-context is using the parent-context as a tunnel.
• the child-context is using the the thread or process of the parent-context.
• the parent of a child-context can be a parent-context or an other child-context. A tree like structure is created.
• the child-context is using the communication interface from the parent-context.
• if a context is deleted (parent or child) the depending context (parent or child) is deleted too.

Function Documentation

rbmqmsgque_MqContextC_LinkConnect()

static OT_ProcRet rbmqmsgque_MqContextC_LinkConnect ( MqContextC_ARGS )

static

Ruby: ctx.LinkConnect() → C-API
re-connect a client-server-link after a server crash or a network downtime …

Definition at line 1219 of file MqContextC_rb.c.

                                                               {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(LinkConnect_doc);
  OT_CHECK_NOARGS;
  MkErrorC_Check(hdl,MqLinkConnect (hdl));
  OT_retObj_SET_None;
  end: MK_UNUSED  /* LONG JUMP on error */
  OT_retObj_RETURN;
}

rbmqmsgque_MqContextC_LinkCreate()

static OT_ProcRet rbmqmsgque_MqContextC_LinkCreate ( MqContextC_ARGS )

static

Ruby: ctx.LinkCreate(?args:MkBufferListC...=nil?) → C-API
make ctx to a parent-context and setup a new client-server-link …

Definition at line 1230 of file MqContextC_rb.c.

                                                              {
  OT_SETUP_hdl;
  OT_SETUP_VARARGS(0,99,LinkCreate_doc);
  MkBufferListCreateTLS_T(args,10);
  OT_CHECK_OPTIONAL(OT_CHECK_BAC (args))
  OT_CHECK_NOARGS;
  MkErrorC_Check(hdl,MqLinkCreate (hdl, args));
  OT_retObj_SET_None;
  end: MK_UNUSED  /* LONG JUMP on error */
  OT_retObj_RETURN;
}

rbmqmsgque_MqContextC_LinkCreateChild()

static OT_ProcRet rbmqmsgque_MqContextC_LinkCreateChild ( MqContextC_ARGS )

static

Ruby: ctx.LinkCreateChild(parent:MqContextC, ?args:MkBufferListC...=nil?) → C-API
make a context to a child-context on-top of an existing parent-client-server-link …

Definition at line 1243 of file MqContextC_rb.c.

                                                                   {
  OT_SETUP_hdl;
  OT_SETUP_VARARGS(1,99,LinkCreateChild_doc);
  MQ_CTX parent = 0;
  OT_CHECK_REQUIRED(OT_CHECK_CTX (parent,MK_NULL_NO))
  MkBufferListCreateTLS_T(args,10);
  OT_CHECK_OPTIONAL(OT_CHECK_BAC (args))
  OT_CHECK_NOARGS;
  MkErrorC_Check(hdl,MqLinkCreateChild (hdl, parent, args));
  OT_retObj_SET_None;
  end: MK_UNUSED  /* LONG JUMP on error */
  OT_retObj_RETURN;
}

rbmqmsgque_MqContextC_LinkDelete()

static OT_ProcRet rbmqmsgque_MqContextC_LinkDelete ( MqContextC_ARGS )

static

Ruby: ctx.LinkDelete() → C-API
close the client-server-link …

Definition at line 1258 of file MqContextC_rb.c.

                                                              {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(LinkDelete_doc);
  OT_CHECK_NOARGS;
  MqLinkDelete (hdl);
  OT_retObj_SET_None;
  end: MK_UNUSED  /* LONG JUMP on error */
  OT_retObj_RETURN;
}

rbmqmsgque_MqContextC_LinkGetCtxId()

static OT_ProcRet rbmqmsgque_MqContextC_LinkGetCtxId ( MqContextC_ARGS )

static

Ruby: int32 ctx.LinkGetCtxId() → C-API
get an identifier which is unique per parent-or-child-context …

Definition at line 1269 of file MqContextC_rb.c.

                                                                {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(LinkGetCtxId_doc);
  OT_CHECK_NOARGS;
  OT_retObj_SET_I32(MqLinkGetCtxId (hdl));
  end: MK_UNUSED  /* LONG JUMP on error */
  OT_retObj_RETURN;
}

rbmqmsgque_MqContextC_LinkGetParent()

static OT_ProcRet rbmqmsgque_MqContextC_LinkGetParent ( MqContextC_ARGS )

static

Ruby: MqContextC ctx.LinkGetParent() → C-API
get the initial parent-context from a client/server link …

Definition at line 1206 of file MqContextC_rb.c.

                                                                 {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(LinkGetParent_doc);
  OT_CHECK_NOARGS;
  MQ_CTX retVal = MqLinkGetParent (hdl);
  OT_retObj_SET_CTX(retVal);
  end: MK_UNUSED  /* LONG JUMP on error */
  OT_retObj_RETURN;
}

rbmqmsgque_MqContextC_LinkGetTargetIdent()

static OT_ProcRet rbmqmsgque_MqContextC_LinkGetTargetIdent ( MqContextC_ARGS )

static

Ruby: string ctx.LinkGetTargetIdent() → C-API
get the ident of the link-target …

Definition at line 1279 of file MqContextC_rb.c.

                                                                      {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(LinkGetTargetIdent_doc);
  OT_CHECK_NOARGS;
  OT_retObj_SET_STR(MqLinkGetTargetIdent (hdl));
  end: MK_UNUSED  /* LONG JUMP on error */
  OT_retObj_RETURN;
}

rbmqmsgque_MqContextC_LinkIsConnected()

static OT_ProcRet rbmqmsgque_MqContextC_LinkIsConnected ( MqContextC_ARGS )

static

Ruby: bool ctx.LinkIsConnected() → C-API
is the context connected? …

Definition at line 1289 of file MqContextC_rb.c.

                                                                   {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(LinkIsConnected_doc);
  OT_CHECK_NOARGS;
  OT_retObj_SET_BOL(MqLinkIsConnected (hdl));
  end: MK_UNUSED  /* LONG JUMP on error */
  OT_retObj_RETURN;
}

rbmqmsgque_MqContextC_LinkIsParent()

static OT_ProcRet rbmqmsgque_MqContextC_LinkIsParent ( MqContextC_ARGS )

static

Ruby: bool ctx.LinkIsParent() → C-API
is the context a parent-context? …

Definition at line 1299 of file MqContextC_rb.c.

                                                                {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(LinkIsParent_doc);
  OT_CHECK_NOARGS;
  OT_retObj_SET_BOL(MqLinkIsParent (hdl));
  end: MK_UNUSED  /* LONG JUMP on error */
  OT_retObj_RETURN;
}

rbmqmsgque_MqContextC_LinkShutdown()

static OT_ProcRet rbmqmsgque_MqContextC_LinkShutdown ( MqContextC_ARGS )

static

Ruby: ctx.LinkShutdown() → C-API
shutdown the communication with a server

Definition at line 1309 of file MqContextC_rb.c.

                                                                {
  OT_SETUP_hdl;
  OT_SETUP_NOARG(LinkShutdown_doc);
  OT_CHECK_NOARGS;
  MkErrorC_Check(hdl,MqLinkShutdown (hdl));
  OT_retObj_SET_None;
  end: MK_UNUSED  /* LONG JUMP on error */
  OT_retObj_RETURN;
}