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

Collaboration diagram for MqContextC_Link_CS_API:

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

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

void	csmqmsgque.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	csmqmsgque.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	csmqmsgque.MqContextC.LinkCreateChild (MqContextC parent, params string[] 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	csmqmsgque.MqContextC.LinkCreate (params string[] args)
	`C#: ctx.LinkCreate(MkBufferListC args = null)` → C-API make ctx to a parent-context and setup a new client-server-link …

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

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

string	csmqmsgque.MqContextC.LinkGetTargetIdent ()
	`C#: string ctx.LinkGetTargetIdent()` → C-API get the ident of the link-target …

bool	csmqmsgque.MqContextC.LinkIsConnected ()
	`C#: bool ctx.LinkIsConnected()` → C-API is the context connected? …

bool	csmqmsgque.MqContextC.LinkIsParent ()
	`C#: bool ctx.LinkIsParent()` → C-API is the context a parent-context? …

void	csmqmsgque.MqContextC.LinkShutdown ()
	`C#: 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

◆ LinkConnect()

void csmqmsgque.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 749 of file MqContextC.cs.

                                {
      MkErrorE errVal = Mq.MqLinkConnect(mkrt, hdl);
      MkErrorC.Check(hdl, errVal);
    }

◆ LinkCreate() [1/2]

void csmqmsgque.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 755 of file MqContextC.cs.

                                                        {
      IntPtr args_hdl = MkBufferListC.getOBJ_null_allow(args);
      MkErrorE errVal = Mq.MqLinkCreate(mkrt, hdl, args_hdl);
      MkErrorC.Check(hdl, errVal);
    }

Here is the caller graph for this function:

◆ LinkCreate() [2/2]

void csmqmsgque.MqContextC.LinkCreate ( params string[] 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 776 of file MqContextC.cs.

                                                   {
      // OVERLOAD
      LinkCreate (new MkBufferListC(args));
    }

◆ LinkCreateChild() [1/2]

void csmqmsgque.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 762 of file MqContextC.cs.

                                                                                {
      IntPtr parent_hdl = MqContextC.getOBJ("MqContextC",parent);
      IntPtr args_hdl = MkBufferListC.getOBJ_null_allow(args);
      MkErrorE errVal = Mq.MqLinkCreateChild(mkrt, hdl, parent_hdl, args_hdl);
      MkErrorC.Check(hdl, errVal);
    }

Here is the caller graph for this function:

◆ LinkCreateChild() [2/2]

void csmqmsgque.MqContextC.LinkCreateChild	(	MqContextC	parent,
		params string[]	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 770 of file MqContextC.cs.

                                                                           {
      // OVERLOAD
      LinkCreateChild (parent, new MkBufferListC(args));
    }

◆ LinkDelete()

void csmqmsgque.MqContextC.LinkDelete ( )

inline

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

Definition at line 782 of file MqContextC.cs.

                               {
      Mq.MqLinkDelete(mkrt, hdl);
    }

◆ LinkGetCtxId()

int csmqmsgque.MqContextC.LinkGetCtxId ( )

inline

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

Definition at line 787 of file MqContextC.cs.

                                {
      Int32 __retVal__L = Mq.MqLinkGetCtxId(hdl);
      return __retVal__L;
    }

◆ LinkGetParent()

MqContextC csmqmsgque.MqContextC.LinkGetParent ( )

inline

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

Definition at line 741 of file MqContextC.cs.

                                        {
      IntPtr __retVal__L = Mq.MqLinkGetParent(hdl);
      return MqContextC.MqContextC_ObjNew(__retVal__L);
    }

◆ LinkGetTargetIdent()

string csmqmsgque.MqContextC.LinkGetTargetIdent ( )

inline

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

Definition at line 793 of file MqContextC.cs.

                                         {
      IntPtr __retVal__L = Mq.MqLinkGetTargetIdent(hdl);
      return Marshal.PtrToStringAnsi(__retVal__L);
    }

◆ LinkIsConnected()

bool csmqmsgque.MqContextC.LinkIsConnected ( )

inline

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

Definition at line 799 of file MqContextC.cs.

                                    {
      bool __retVal__L = Mq.MqLinkIsConnected(hdl);
      return __retVal__L;
    }

◆ LinkIsParent()

bool csmqmsgque.MqContextC.LinkIsParent ( )

inline

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

Definition at line 805 of file MqContextC.cs.

                                 {
      bool __retVal__L = Mq.MqLinkIsParent(hdl);
      return __retVal__L;
    }

◆ LinkShutdown()

void csmqmsgque.MqContextC.LinkShutdown ( )

inline

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

Definition at line 811 of file MqContextC.cs.

                                 {
      MkErrorE errVal = Mq.MqLinkShutdown(mkrt, hdl);
      MkErrorC.Check(hdl, errVal);
    }

Functions

Detailed Description

Function Documentation

◆ LinkConnect()

◆ LinkCreate() [1/2]

◆ LinkCreate() [2/2]

◆ LinkCreateChild() [1/2]

◆ LinkCreateChild() [2/2]

◆ LinkDelete()

◆ LinkGetCtxId()

◆ LinkGetParent()

◆ LinkGetTargetIdent()

◆ LinkIsConnected()

◆ LinkIsParent()

◆ LinkShutdown()