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

Collaboration diagram for MqContextC_Link_CC_API:

Functions
MqContextC *	ccmqmsgque::MqContextC::LinkGetParent ()
	`C++: MqContextC* ctx.LinkGetParent()` → C-API get the initial parent-context from a client/server link …

void	ccmqmsgque::MqContextC::LinkConnect ()
	`C++: ctx.LinkConnect()` → C-API re-connect a client-server-link after a server crash or a network downtime …

void	ccmqmsgque::MqContextC::LinkCreate (MkBufferListC *args=NULL)
	`C++: ctx.LinkCreate(MkBufferListC* args = NULL)` → C-API make ctx to a parent-context and setup a new client-server-link …

void	ccmqmsgque::MqContextC::LinkCreate (const MkBufferListC &args)
	`C++: ctx.LinkCreate(MkBufferListC* args = NULL)` → C-API make ctx to a parent-context and setup a new client-server-link …

void	ccmqmsgque::MqContextC::LinkCreateChild (MqContextC parent, MkBufferListC args=NULL)
	`C++: ctx.LinkCreateChild(MqContextC* parent, MkBufferListC* args = NULL)` → C-API make a context to a child-context on-top of an existing parent-client-server-link …

void	ccmqmsgque::MqContextC::LinkCreateChild (const MqContextC &parent, const MkBufferListC &args)
	`C++: ctx.LinkCreateChild(MqContextC* parent, MkBufferListC* args = NULL)` → C-API make a context to a child-context on-top of an existing parent-client-server-link …

void	ccmqmsgque::MqContextC::LinkDelete ()
	`C++: ctx.LinkDelete()` → C-API close the client-server-link …

MK_NUM	ccmqmsgque::MqContextC::LinkGetCtxId ()
	`C++: MK_NUM ctx.LinkGetCtxId()` → C-API get an identifier which is unique per parent-or-child-context …

MK_STRN	ccmqmsgque::MqContextC::LinkGetTargetIdent ()
	`C++: MK_STRN ctx.LinkGetTargetIdent()` → C-API get the ident of the link-target …

MK_BOOL	ccmqmsgque::MqContextC::LinkIsConnected ()
	`C++: MK_BOOL ctx.LinkIsConnected()` → C-API is the context connected? …

MK_BOOL	ccmqmsgque::MqContextC::LinkIsParent ()
	`C++: MK_BOOL ctx.LinkIsParent()` → C-API is the context a parent-context? …

void	ccmqmsgque::MqContextC::LinkShutdown ()
	`C++: ctx.LinkShutdown()` → C-API shutdown the communication with a server

void	ccmqmsgque::MqContextC::LinkCheckOptionI32 (MK_STRN opt, MK_I32 *val)
	`C++: ctx.LinkCreate(MkBufferListC* args = NULL)` → C-API make ctx to a parent-context and setup a new client-server-link …

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 IServerSetup and the MqFactoryC interface.
- a server-context have to enter the event-loop and wait for incoming service-request using MqProcessEvent together with the libmqmsgque::MQ_WAIT_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.

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 IServerSetup and the MqFactoryC interface.
- a server-context have to enter the event-loop and wait for incoming service-request using MqProcessEvent together with the libmqmsgque::MQ_WAIT_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

◆ LinkCheckOptionI32()

void ccmqmsgque::MqContextC::LinkCheckOptionI32	(	MK_STRN	opt,
		MK_I32 *	val )

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

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

Definition at line 171 of file LibMqMsgque_cc.cc.

                                                               {
    MkRtSetup_NULL;
    ErrorCheck (MkBufferListCheckOptionI32 (reinterpret_cast<MQ_CTX>(hdl)->link.alfa, opt, 0, true, val));
  }

Here is the caller graph for this function:

◆ LinkConnect()

void ccmqmsgque::MqContextC::LinkConnect ( )

inline

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

Definition at line 838 of file MqContextC_inline_cc.hh.

                                        {
    MK_UNUSED auto ctx = getCTX(MK_NULL_NO);
    MkRtSetup_X(ctx);
    enum MkErrorE errVal = MqLinkConnect(ctx);
    MkErrorC_Check(ctx, errVal);
  }

◆ LinkCreate() [1/2]

void ccmqmsgque::MqContextC::LinkCreate ( const MkBufferListC & args )

inline

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

Definition at line 855 of file MqContextC_inline_cc.hh.

                                                                {
    MK_UNUSED auto ctx = getCTX(MK_NULL_NO);
    MkRtSetup_X(ctx);
    const MK_BAC args_hdl = MkBufferListC::getBFL(args,MK_NULL_NO);
    enum MkErrorE errVal = MqLinkCreate(ctx, args_hdl);
    MkErrorC_Check(ctx, errVal);
  }

◆ LinkCreate() [2/2]

void ccmqmsgque::MqContextC::LinkCreate ( MkBufferListC * args = NULL )

inline

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

Definition at line 846 of file MqContextC_inline_cc.hh.

                                                          {
    MK_UNUSED auto ctx = getCTX(MK_NULL_NO);
    MkRtSetup_X(ctx);
    MK_BAC args_hdl = MkBufferListC::getBFL(args,MK_NULL_YES);
    enum MkErrorE errVal = MqLinkCreate(ctx, args_hdl);
    MkErrorC_Check(ctx, errVal);
  }

Here is the caller graph for this function:

◆ LinkCreateChild() [1/2]

void ccmqmsgque::MqContextC::LinkCreateChild	(	const MqContextC &	parent,
		const MkBufferListC &	args )

inline

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

Definition at line 874 of file MqContextC_inline_cc.hh.

                                                                                               {
    MK_UNUSED auto ctx = getCTX(MK_NULL_NO);
    MkRtSetup_X(ctx);
    const MQ_CTX parent_hdl = MqContextC::getCTX(parent,MK_NULL_NO);
    const MK_BAC args_hdl = MkBufferListC::getBFL(args,MK_NULL_NO);
    enum MkErrorE errVal = MqLinkCreateChild(ctx, parent_hdl, args_hdl);
    MkErrorC_Check(ctx, errVal);
  }

◆ LinkCreateChild() [2/2]

void ccmqmsgque::MqContextC::LinkCreateChild	(	MqContextC *	parent,
		MkBufferListC *	args = NULL )

inline

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

Definition at line 864 of file MqContextC_inline_cc.hh.

                                                                                   {
    MK_UNUSED auto ctx = getCTX(MK_NULL_NO);
    MkRtSetup_X(ctx);
    MQ_CTX parent_hdl = MqContextC::getCTX(parent,MK_NULL_NO);
    MK_BAC args_hdl = MkBufferListC::getBFL(args,MK_NULL_YES);
    enum MkErrorE errVal = MqLinkCreateChild(ctx, parent_hdl, args_hdl);
    MkErrorC_Check(ctx, errVal);
  }

◆ LinkDelete()

void ccmqmsgque::MqContextC::LinkDelete ( )

inline

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

Definition at line 884 of file MqContextC_inline_cc.hh.

                                       {
    MK_UNUSED auto ctx = getCTX(MK_NULL_NO);
    MkRtSetup_X(ctx);
    MqLinkDelete(ctx);
  }

◆ LinkGetCtxId()

MK_NUM ccmqmsgque::MqContextC::LinkGetCtxId ( )

inline

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

Definition at line 891 of file MqContextC_inline_cc.hh.

                                           {
    MK_UNUSED auto ctx = getCTX(MK_NULL_NO);
    MkRtSetup_X(ctx);
    MK_NUM __retVal__L = MqLinkGetCtxId(ctx);
    return __retVal__L;
  }

◆ LinkGetParent()

MqContextC * ccmqmsgque::MqContextC::LinkGetParent ( )

inline

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

Definition at line 828 of file MqContextC_inline_cc.hh.

                                                 {
    MK_UNUSED auto ctx = getCTX(MK_NULL_NO);
    MkRtSetup_X(ctx);
    MQ_CTX __retVal__L = MqLinkGetParent(ctx);
    return MqContextC::MqContextC_ObjNew(MK_RT_CALL __retVal__L);
  }

◆ LinkGetTargetIdent()

MK_STRN ccmqmsgque::MqContextC::LinkGetTargetIdent ( )

inline

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

Definition at line 899 of file MqContextC_inline_cc.hh.

                                                  {
    MK_UNUSED auto ctx = getCTX(MK_NULL_NO);
    MkRtSetup_X(ctx);
    MK_STRN __retVal__L = MqLinkGetTargetIdent(ctx);
    return __retVal__L;
  }

◆ LinkIsConnected()

MK_BOOL ccmqmsgque::MqContextC::LinkIsConnected ( )

inline

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

Definition at line 907 of file MqContextC_inline_cc.hh.

                                               {
    MK_UNUSED auto ctx = getCTX(MK_NULL_NO);
    MkRtSetup_X(ctx);
    MK_BOOL __retVal__L = MqLinkIsConnected(ctx);
    return __retVal__L;
  }

◆ LinkIsParent()

MK_BOOL ccmqmsgque::MqContextC::LinkIsParent ( )

inline

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

Definition at line 915 of file MqContextC_inline_cc.hh.

                                            {
    MK_UNUSED auto ctx = getCTX(MK_NULL_NO);
    MkRtSetup_X(ctx);
    MK_BOOL __retVal__L = MqLinkIsParent(ctx);
    return __retVal__L;
  }

◆ LinkShutdown()

void ccmqmsgque::MqContextC::LinkShutdown ( )

inline

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

Definition at line 923 of file MqContextC_inline_cc.hh.

                                         {
    MK_UNUSED auto ctx = getCTX(MK_NULL_NO);
    MkRtSetup_X(ctx);
    enum MkErrorE errVal = MqLinkShutdown(ctx);
    MkErrorC_Check(ctx, errVal);
  }

Functions

Detailed Description

Function Documentation

◆ LinkCheckOptionI32()

◆ LinkConnect()

◆ LinkCreate() [1/2]

◆ LinkCreate() [2/2]

◆ LinkCreateChild() [1/2]

◆ LinkCreateChild() [2/2]

◆ LinkDelete()

◆ LinkGetCtxId()

◆ LinkGetParent()

◆ LinkGetTargetIdent()

◆ LinkIsConnected()

◆ LinkIsParent()

◆ LinkShutdown()