MqContextC_Link_JV_API

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

Collaboration diagram for MqContextC_Link_JV_API:

Functions
native MqContextC	jvmqmsgque.MqContextC.LinkGetParent ()
	Java: MqContextC ctx.LinkGetParent() → C-API get the initial parent-context from a client/server link …
native void	jvmqmsgque.MqContextC.LinkConnect ()
	Java: ctx.LinkConnect() → C-API re-connect a client-server-link after a server crash or a network downtime …
native void	jvmqmsgque.MqContextC.LinkCreate (MkBufferListC args)
	Java: ctx.LinkCreate(?MkBufferListC args = null?) → C-API make ctx to a parent-context and setup a new client-server-link …
native void	jvmqmsgque.MqContextC.LinkCreateChild (MqContextC parent, MkBufferListC args)
	Java: 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	jvmqmsgque.MqContextC.LinkCreateChild (MqContextC parent, String... args)
	Java: 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	jvmqmsgque.MqContextC.LinkCreateChild (MqContextC parent)
	Java: 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	jvmqmsgque.MqContextC.LinkCreate (String... args)
	Java: ctx.LinkCreate(?MkBufferListC args = null?) → C-API make ctx to a parent-context and setup a new client-server-link …
void	jvmqmsgque.MqContextC.LinkCreate ()
	Java: ctx.LinkCreate(?MkBufferListC args = null?) → C-API make ctx to a parent-context and setup a new client-server-link …
native void	jvmqmsgque.MqContextC.LinkDelete ()
	Java: ctx.LinkDelete() → C-API close the client-server-link …
native int	jvmqmsgque.MqContextC.LinkGetCtxId ()
	Java: int ctx.LinkGetCtxId() → C-API get an identifier which is unique per parent-or-child-context …
native String	jvmqmsgque.MqContextC.LinkGetTargetIdent ()
	Java: String ctx.LinkGetTargetIdent() → C-API get the ident of the link-target …
native boolean	jvmqmsgque.MqContextC.LinkIsConnected ()
	Java: boolean ctx.LinkIsConnected() → C-API is the context connected? …
native boolean	jvmqmsgque.MqContextC.LinkIsParent ()
	Java: boolean ctx.LinkIsParent() → C-API is the context a parent-context? …
native void	jvmqmsgque.MqContextC.LinkShutdown ()
	Java: ctx.LinkShutdown() → C-API shutdown the communication with a server
JNIEXPORT jobject JNICALL	Java_jvmqmsgque_MqContextC_LinkGetParent (JNIEnv *env, jobject self)
	Java: MqContextC ctx.LinkGetParent() → C-API get the initial parent-context from a client/server link …
JNIEXPORT void JNICALL	Java_jvmqmsgque_MqContextC_LinkConnect (JNIEnv *env, jobject self)
	Java: ctx.LinkConnect() → C-API re-connect a client-server-link after a server crash or a network downtime …
JNIEXPORT void JNICALL	Java_jvmqmsgque_MqContextC_LinkCreate (JNIEnv *env, jobject self, jobject args)
	Java: ctx.LinkCreate(?MkBufferListC args = null?) → C-API make ctx to a parent-context and setup a new client-server-link …
JNIEXPORT void JNICALL	Java_jvmqmsgque_MqContextC_LinkCreateChild (JNIEnv *env, jobject self, jobject parent, jobject args)
	Java: 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 …
JNIEXPORT void JNICALL	Java_jvmqmsgque_MqContextC_LinkDelete (JNIEnv *env, jobject self)
	Java: ctx.LinkDelete() → C-API close the client-server-link …
JNIEXPORT jint JNICALL	Java_jvmqmsgque_MqContextC_LinkGetCtxId (JNIEnv *env, jobject self)
	Java: int ctx.LinkGetCtxId() → C-API get an identifier which is unique per parent-or-child-context …
JNIEXPORT jstring JNICALL	Java_jvmqmsgque_MqContextC_LinkGetTargetIdent (JNIEnv *env, jobject self)
	Java: String ctx.LinkGetTargetIdent() → C-API get the ident of the link-target …
JNIEXPORT jboolean JNICALL	Java_jvmqmsgque_MqContextC_LinkIsConnected (JNIEnv *env, jobject self)
	Java: boolean ctx.LinkIsConnected() → C-API is the context connected? …
JNIEXPORT jboolean JNICALL	Java_jvmqmsgque_MqContextC_LinkIsParent (JNIEnv *env, jobject self)
	Java: boolean ctx.LinkIsParent() → C-API is the context a parent-context? …
JNIEXPORT void JNICALL	Java_jvmqmsgque_MqContextC_LinkShutdown (JNIEnv *env, jobject self)
	Java: 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.

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

Java_jvmqmsgque_MqContextC_LinkConnect()

JNIEXPORT void JNICALL Java_jvmqmsgque_MqContextC_LinkConnect	(	JNIEnv *	env,
		jobject	self )

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

Definition at line 894 of file MqContextC_jv.c.

                                                                                           {
  MQ_CTX hdl = (MQ_CTX)pObj2Hdl(env,"MqContextC",self);
  JavaErrorCheck;
  MkRtSetup_X(hdl);
  enum MkErrorE errVal = MqLinkConnect(hdl);
  MkErrorC_Check(hdl, errVal)
error:
  return;
}

Java_jvmqmsgque_MqContextC_LinkCreate()

JNIEXPORT void JNICALL Java_jvmqmsgque_MqContextC_LinkCreate	(	JNIEnv *	env,
		jobject	self,
		jobject	args )

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

Definition at line 905 of file MqContextC_jv.c.

                                                                                                        {
  MQ_CTX hdl = (MQ_CTX)pObj2Hdl(env,"MqContextC",self);
  JavaErrorCheck;
  MkRtSetup_X(hdl);
  MK_BAC args_hdl = (MK_BAC)pObj2Hdl__null_allow(env,args);
  JavaErrorCheck;
  enum MkErrorE errVal = MqLinkCreate(hdl, args_hdl);
  MkErrorC_Check(hdl, errVal)
error:
  return;
}

Java_jvmqmsgque_MqContextC_LinkCreateChild()

JNIEXPORT void JNICALL Java_jvmqmsgque_MqContextC_LinkCreateChild	(	JNIEnv *	env,
		jobject	self,
		jobject	parent,
		jobject	args )

Java: 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 918 of file MqContextC_jv.c.

                                                                                                                             {
  MQ_CTX hdl = (MQ_CTX)pObj2Hdl(env,"MqContextC",self);
  JavaErrorCheck;
  MkRtSetup_X(hdl);
  MQ_CTX parent_hdl = (MQ_CTX)pObj2Hdl(env,"MqContextC",parent);
  JavaErrorCheck;
  MK_BAC args_hdl = (MK_BAC)pObj2Hdl__null_allow(env,args);
  JavaErrorCheck;
  enum MkErrorE errVal = MqLinkCreateChild(hdl, parent_hdl, args_hdl);
  MkErrorC_Check(hdl, errVal)
error:
  return;
}

Java_jvmqmsgque_MqContextC_LinkDelete()

JNIEXPORT void JNICALL Java_jvmqmsgque_MqContextC_LinkDelete	(	JNIEnv *	env,
		jobject	self )

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

Definition at line 933 of file MqContextC_jv.c.

                                                                                          {
  MQ_CTX hdl = (MQ_CTX)pObj2Hdl(env,"MqContextC",self);
  JavaErrorCheck;
  MkRtSetup_X(hdl);
  MqLinkDelete(hdl);
error:
  return;
}

Java_jvmqmsgque_MqContextC_LinkGetCtxId()

JNIEXPORT jint JNICALL Java_jvmqmsgque_MqContextC_LinkGetCtxId	(	JNIEnv *	env,
		jobject	self )

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

Definition at line 943 of file MqContextC_jv.c.

                                                                                            {
  MQ_CTX hdl = (MQ_CTX)pObj2Hdl(env,"MqContextC",self);
  JavaErrorCheck;
  MkRtSetup_X(hdl);
  MK_NUM __retVal__L = MqLinkGetCtxId(hdl);
  jint __retVal__S = __retVal__L;
  return __retVal__S;
error:
  return 0;
}

Java_jvmqmsgque_MqContextC_LinkGetParent()

JNIEXPORT jobject JNICALL Java_jvmqmsgque_MqContextC_LinkGetParent	(	JNIEnv *	env,
		jobject	self )

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

Definition at line 880 of file MqContextC_jv.c.

                                                                                                {
  MQ_CTX hdl = (MQ_CTX)pObj2Hdl(env,"MqContextC",self);
  JavaErrorCheck;
  MkRtSetup_X(hdl);
  MQ_CTX __retVal__L = MqLinkGetParent(hdl);
  jobject __retVal__S = MQ(MqContextC_ObjNew)(MK_RT_CALL env,__retVal__L);
  return __retVal__S;
error:
  return 0;
}

Java_jvmqmsgque_MqContextC_LinkGetTargetIdent()

JNIEXPORT jstring JNICALL Java_jvmqmsgque_MqContextC_LinkGetTargetIdent	(	JNIEnv *	env,
		jobject	self )

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

Definition at line 955 of file MqContextC_jv.c.

                                                                                                     {
  MQ_CTX hdl = (MQ_CTX)pObj2Hdl(env,"MqContextC",self);
  JavaErrorCheck;
  MkRtSetup_X(hdl);
  MK_STRN __retVal__L = MqLinkGetTargetIdent(hdl);
  jstring __retVal__S = JC2O(env,__retVal__L);
  return __retVal__S;
error:
  return 0;
}

Java_jvmqmsgque_MqContextC_LinkIsConnected()

JNIEXPORT jboolean JNICALL Java_jvmqmsgque_MqContextC_LinkIsConnected	(	JNIEnv *	env,
		jobject	self )

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

Definition at line 967 of file MqContextC_jv.c.

                                                                                                   {
  MQ_CTX hdl = (MQ_CTX)pObj2Hdl(env,"MqContextC",self);
  JavaErrorCheck;
  MkRtSetup_X(hdl);
  MK_BOOL __retVal__L = MqLinkIsConnected(hdl);
  jboolean __retVal__S = __retVal__L;
  return __retVal__S;
error:
  return 0;
}

Java_jvmqmsgque_MqContextC_LinkIsParent()

JNIEXPORT jboolean JNICALL Java_jvmqmsgque_MqContextC_LinkIsParent	(	JNIEnv *	env,
		jobject	self )

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

Definition at line 979 of file MqContextC_jv.c.

                                                                                                {
  MQ_CTX hdl = (MQ_CTX)pObj2Hdl(env,"MqContextC",self);
  JavaErrorCheck;
  MkRtSetup_X(hdl);
  MK_BOOL __retVal__L = MqLinkIsParent(hdl);
  jboolean __retVal__S = __retVal__L;
  return __retVal__S;
error:
  return 0;
}

Java_jvmqmsgque_MqContextC_LinkShutdown()

JNIEXPORT void JNICALL Java_jvmqmsgque_MqContextC_LinkShutdown	(	JNIEnv *	env,
		jobject	self )

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

Definition at line 991 of file MqContextC_jv.c.

                                                                                            {
  MQ_CTX hdl = (MQ_CTX)pObj2Hdl(env,"MqContextC",self);
  JavaErrorCheck;
  MkRtSetup_X(hdl);
  enum MkErrorE errVal = MqLinkShutdown(hdl);
  MkErrorC_Check(hdl, errVal)
error:
  return;
}

LinkConnect()

native void jvmqmsgque.MqContextC.LinkConnect

(

)

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

LinkCreate() [1/3]

void jvmqmsgque.MqContextC.LinkCreate

(

)

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

Definition at line 363 of file MqContextC.java.

                            {
    LinkCreate ((MkBufferListC) null);
  }

Here is the caller graph for this function:

LinkCreate() [2/3]

native void jvmqmsgque.MqContextC.LinkCreate

(

MkBufferListC

args

)

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

LinkCreate() [3/3]

void jvmqmsgque.MqContextC.LinkCreate

(

String...

args

)

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

Definition at line 358 of file MqContextC.java.

                                          {
    LinkCreate (new MkBufferListC(args));
  }

LinkCreateChild() [1/3]

void jvmqmsgque.MqContextC.LinkCreateChild

(

MqContextC

parent

)

Java: 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 353 of file MqContextC.java.

                                                  {
    LinkCreateChild (parent, (MkBufferListC) null);
  }

LinkCreateChild() [2/3]

native void jvmqmsgque.MqContextC.LinkCreateChild	(	MqContextC	parent,
		MkBufferListC	args )

Java: 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 …

Here is the caller graph for this function:

LinkCreateChild() [3/3]

void jvmqmsgque.MqContextC.LinkCreateChild	(	MqContextC	parent,
		String...	args )

Java: 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 348 of file MqContextC.java.

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

LinkDelete()

native void jvmqmsgque.MqContextC.LinkDelete

(

)

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

LinkGetCtxId()

native int jvmqmsgque.MqContextC.LinkGetCtxId

(

)

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

LinkGetParent()

native MqContextC jvmqmsgque.MqContextC.LinkGetParent

(

)

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

LinkGetTargetIdent()

native String jvmqmsgque.MqContextC.LinkGetTargetIdent

(

)

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

LinkIsConnected()

native boolean jvmqmsgque.MqContextC.LinkIsConnected

(

)

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

LinkIsParent()

native boolean jvmqmsgque.MqContextC.LinkIsParent

(

)

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

LinkShutdown()

native void jvmqmsgque.MqContextC.LinkShutdown

(

)

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