MqContextC - create and manage a service … More...

Collaboration diagram for MqContextC_Service_CS_API:

Functions
void	csmqmsgque.MqContextC.ServiceCreate (string token, MqServiceCCB callback)
	`C#: ctx.ServiceCreate(string token, MqServiceICB\|MqServiceCCB\|MqServiceIF callback)` → C-API create a link between a service-token and a service-callback …

void	csmqmsgque.MqContextC.ServiceCreate (string token, MqServiceICB callback)
	`C#: ctx.ServiceCreate(string token, MqServiceICB\|MqServiceCCB\|MqServiceIF callback)` → C-API create a link between a service-token and a service-callback …

void	csmqmsgque.MqContextC.ServiceCreate (string token, MqServiceIF callback)
	`C#: ctx.ServiceCreate(string token, MqServiceICB\|MqServiceCCB\|MqServiceIF callback)` → C-API create a link between a service-token and a service-callback …

void	csmqmsgque.MqContextC.ServiceDelete (string token)
	`C#: ctx.ServiceDelete(string token)` → C-API delete a service. …

bool	csmqmsgque.MqContextC.ServiceIsTransaction ()
	`C#: bool ctx.ServiceIsTransaction()` → C-API check if the ongoing-service-call belongs to a transaction …

void	csmqmsgque.MqContextC.ServiceProxy (string token, int id=(int) MqSlaveE.OTHER)
	`C#: ctx.ServiceProxy(string token, int id = (int)MqSlaveE.OTHER)` → C-API create a service to link a master-context with a slave-context. …

void	csmqmsgque.MqContextC.ServiceProxyCtx (string token, MqContextC target)
	`C#: ctx.ServiceProxyCtx(string token, MqContextC target)` → C-API same as MqServiceProxy but use an MqContextC as input.

bool	csmqmsgque.MqContextC.ServiceProxyCtxExists (string token, MqContextC target)
	`C#: bool ctx.ServiceProxyCtxExists(string token, MqContextC target)` → C-API check if service who belongs to token is a proxy-service

void	csmqmsgque.MqContextC.ServiceProxyRoundRobin (string token, string ident)
	`C#: ctx.ServiceProxyRoundRobin(string token, string ident)` → C-API create a proxy-service using Round-Robin as load-balancer …

void	csmqmsgque.MqContextC.ServiceStorage (string token)
	`C#: ctx.ServiceStorage(string token)` → C-API setup a service listen on a MqContextC_ServiceApi_Identifer and save all read-data-package into the STORAGE …

bool	csmqmsgque.MqContextC.ServiceTokenCheck (string token)
	`C#: bool ctx.ServiceTokenCheck(string token)` → C-API in an ongoing-service-call check if the current MqContextC_ServiceApi_Identifer is *token* …

bool	csmqmsgque.MqContextC.ServiceTokenExists (string token)
	`C#: bool ctx.ServiceTokenExists(string token)` → C-API check if the MqContextC_ServiceApi_Identifer *token* is defined as *ctx* service …

string	csmqmsgque.MqContextC.ServiceTokenGet ()
	`C#: string ctx.ServiceTokenGet()` → C-API in an ongoing-service-call get the current MqContextC_ServiceApi_Identifer …

Detailed Description

MqContextC - create and manage a service …

To provide a service is the main purpose of a server and the main-purpose of a client/server connection is to call a service and to process the result.
A service can be defined on the server or on the client. On the server a service can be initial setup with MqServerSetupIF method and finally cleanup with MqServerCleanupIF.

‍A service is created with the MqServiceCreate and deleted with the MqServiceDelete.

A service can be created and deleted during the entire life-cycle of the server or the client. If the server/client-context is deleted all services of the are deleted also.

‍A MqServiceDelete is not required.

Creating or deleting a service is like granting or revoking the right to access a single feature.

eventloop

To receive a data-package on a service the event-loop have to be active. The event-loop ia always active on an synchronous-service-call . On a server the event-loop is started with MqProcessEvent at startup.

synchronous-service-call: A synchronous-service-call always block and enter the event-loop to wait for an answer

asynchronous-service-call: A asynchronous-service-call always return immediately and the possible result is received on a callback

callback

A callback is the function called by a service and required to receive data from remote.
A callback is created with MqServiceCreate or is part of the service-call.
A callback can be a service-identifer or a service-callback.

service-call with callback: SendEND_AND_CALLBACK, SendEND_AND_SUB, SendEND_AND_TRANSACTION

service-call without callback: SendEND, SendEND_AND_WAIT

Example from MyServer.cs → define the service HLWO on the server-link-setup

using System;
using csmqmsgque;

namespace example {

  // package-item
  sealed class MyServer : MqContextC, MqServerSetupIF {

    // factory constructor
    public MyServer(MqContextC tmpl=null) : base(tmpl) {
    }

    // service to serve all incoming requests for token "HLWO"
    public void MyFirstService () {
      SendSTART();
      SendSTR("Hello World");
      SendRETURN();
    }

    // define a service as link between the token "HLWO" and the callback "MyFirstService"
    void MqServerSetupIF.ServerSetup() {
      ServiceCreate("HLWO", MyFirstService);
    }

    // package-main
    static void Main(string[] argv) {
  
      // create the "MyServer" factory… and the object
      var srv = MqFactoryCT<MyServer>.Add().New();

      try {
	srv.LinkCreate(argv);
	srv.ProcessEvent(MqWaitOnEventE.FOREVER);
      } catch (Exception ex) {
        srv.ErrorCatch (ex);
      }
      srv.Exit();
    }
  }
}

Function Documentation

◆ ServiceCreate() [1/3]

void csmqmsgque.MqContextC.ServiceCreate	(	string	token,
		MqServiceCCB	callback )

inline

C#: ctx.ServiceCreate(string token, MqServiceICB|MqServiceCCB|MqServiceIF callback) → C-API
create a link between a service-token and a service-callback …

Definition at line 1601 of file MqContextC.cs.

                                                                     {
      IntPtr token_cstr = Marshal.StringToHGlobalAnsi(token);
      IntPtr callback_ptr = callback == null ? IntPtr.Zero : (IntPtr)GCHandle.Alloc(new MqCall(mkrt,callback));
      MkErrorE errVal = Mq.MqServiceCreate(mkrt, hdl, token_cstr, ServiceCall, callback_ptr, ServiceFree, null);
      Marshal.FreeHGlobal(token_cstr);
      MkErrorC.Check(hdl, errVal);
    }

◆ ServiceCreate() [2/3]

void csmqmsgque.MqContextC.ServiceCreate	(	string	token,
		MqServiceICB	callback )

inline

C#: ctx.ServiceCreate(string token, MqServiceICB|MqServiceCCB|MqServiceIF callback) → C-API
create a link between a service-token and a service-callback …

Definition at line 1610 of file MqContextC.cs.

                                                                     {
      IntPtr token_cstr = Marshal.StringToHGlobalAnsi(token);
      IntPtr callback_ptr = callback == null ? IntPtr.Zero : (IntPtr)GCHandle.Alloc(new MqCall(mkrt,callback));
      MkErrorE errVal = Mq.MqServiceCreate(mkrt, hdl, token_cstr, ServiceCall, callback_ptr, ServiceFree, null);
      Marshal.FreeHGlobal(token_cstr);
      MkErrorC.Check(hdl, errVal);
    }

◆ ServiceCreate() [3/3]

void csmqmsgque.MqContextC.ServiceCreate	(	string	token,
		MqServiceIF	callback )

inline

C#: ctx.ServiceCreate(string token, MqServiceICB|MqServiceCCB|MqServiceIF callback) → C-API
create a link between a service-token and a service-callback …

Definition at line 1619 of file MqContextC.cs.

                                                                    {
      IntPtr token_cstr = Marshal.StringToHGlobalAnsi(token);
      IntPtr callback_ptr = callback == null ? IntPtr.Zero : (IntPtr)GCHandle.Alloc(new MqCall(mkrt,callback));
      MkErrorE errVal = Mq.MqServiceCreate(mkrt, hdl, token_cstr, ServiceCall, callback_ptr, ServiceFree, null);
      Marshal.FreeHGlobal(token_cstr);
      MkErrorC.Check(hdl, errVal);
    }

◆ ServiceDelete()

void csmqmsgque.MqContextC.ServiceDelete ( string token )

inline

C#: ctx.ServiceDelete(string token) → C-API
delete a service. …

Definition at line 1628 of file MqContextC.cs.

                                              {
      IntPtr token_cstr = Marshal.StringToHGlobalAnsi(token);
      MkErrorE errVal = Mq.MqServiceDelete(mkrt, hdl, token_cstr);
      Marshal.FreeHGlobal(token_cstr);
      MkErrorC.Check(hdl, errVal);
    }

◆ ServiceIsTransaction()

bool csmqmsgque.MqContextC.ServiceIsTransaction ( )

inline

C#: bool ctx.ServiceIsTransaction() → C-API
check if the ongoing-service-call belongs to a transaction …

Definition at line 1636 of file MqContextC.cs.

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

◆ ServiceProxy()

void csmqmsgque.MqContextC.ServiceProxy	(	string	token,
		int	id = (int)MqSlaveE::OTHER )

inline

C#: ctx.ServiceProxy(string token, int id = (int)MqSlaveE.OTHER) → C-API
create a service to link a master-context with a slave-context. …

Definition at line 1642 of file MqContextC.cs.

                                                                           {
      IntPtr token_cstr = Marshal.StringToHGlobalAnsi(token);
      MkErrorE errVal = Mq.MqServiceProxy(mkrt, hdl, token_cstr, id);
      Marshal.FreeHGlobal(token_cstr);
      MkErrorC.Check(hdl, errVal);
    }

◆ ServiceProxyCtx()

void csmqmsgque.MqContextC.ServiceProxyCtx	(	string	token,
		MqContextC	target )

inline

C#: ctx.ServiceProxyCtx(string token, MqContextC target) → C-API
same as MqServiceProxy but use an MqContextC as input.

Definition at line 1650 of file MqContextC.cs.

                                                                   {
      IntPtr target_hdl = MqContextC.getOBJ("MqContextC",target);
      IntPtr token_cstr = Marshal.StringToHGlobalAnsi(token);
      MkErrorE errVal = Mq.MqServiceProxyCtx(mkrt, hdl, token_cstr, target_hdl);
      Marshal.FreeHGlobal(token_cstr);
      MkErrorC.Check(hdl, errVal);
    }

◆ ServiceProxyCtxExists()

bool csmqmsgque.MqContextC.ServiceProxyCtxExists	(	string	token,
		MqContextC	target )

inline

C#: bool ctx.ServiceProxyCtxExists(string token, MqContextC target) → C-API
check if service who belongs to token is a proxy-service

Definition at line 1659 of file MqContextC.cs.

                                                                         {
      IntPtr target_hdl = MqContextC.getOBJ("MqContextC",target);
      IntPtr token_cstr = Marshal.StringToHGlobalAnsi(token);
      bool __retVal__L = Mq.MqServiceProxyCtxExists(hdl, token_cstr, target_hdl);
      Marshal.FreeHGlobal(token_cstr);
      return __retVal__L;
    }

◆ ServiceProxyRoundRobin()

void csmqmsgque.MqContextC.ServiceProxyRoundRobin	(	string	token,
		string	ident )

inline

C#: ctx.ServiceProxyRoundRobin(string token, string ident) → C-API
create a proxy-service using Round-Robin as load-balancer …

Definition at line 1668 of file MqContextC.cs.

                                                                     {
      IntPtr token_cstr = Marshal.StringToHGlobalAnsi(token);
      IntPtr ident_cstr = Marshal.StringToHGlobalAnsi(ident);
      MkErrorE errVal = Mq.MqServiceProxyRoundRobin(mkrt, hdl, token_cstr, ident_cstr);
      Marshal.FreeHGlobal(token_cstr);
      Marshal.FreeHGlobal(ident_cstr);
      MkErrorC.Check(hdl, errVal);
    }

◆ ServiceStorage()

void csmqmsgque.MqContextC.ServiceStorage ( string token )

inline

C#: ctx.ServiceStorage(string token) → C-API
setup a service listen on a MqContextC_ServiceApi_Identifer and save all read-data-package into the STORAGE …

Definition at line 1678 of file MqContextC.cs.

                                               {
      IntPtr token_cstr = Marshal.StringToHGlobalAnsi(token);
      MkErrorE errVal = Mq.MqServiceStorage(mkrt, hdl, token_cstr);
      Marshal.FreeHGlobal(token_cstr);
      MkErrorC.Check(hdl, errVal);
    }

◆ ServiceTokenCheck()

bool csmqmsgque.MqContextC.ServiceTokenCheck ( string token )

inline

C#: bool ctx.ServiceTokenCheck(string token) → C-API
in an ongoing-service-call check if the current MqContextC_ServiceApi_Identifer is token …

Definition at line 1686 of file MqContextC.cs.

                                                  {
      IntPtr token_cstr = Marshal.StringToHGlobalAnsi(token);
      bool __retVal__L = Mq.MqServiceTokenCheck(hdl, token_cstr);
      Marshal.FreeHGlobal(token_cstr);
      return __retVal__L;
    }

◆ ServiceTokenExists()

bool csmqmsgque.MqContextC.ServiceTokenExists ( string token )

inline

C#: bool ctx.ServiceTokenExists(string token) → C-API
check if the MqContextC_ServiceApi_Identifer token is defined as ctx service …

Definition at line 1694 of file MqContextC.cs.

                                                   {
      IntPtr token_cstr = Marshal.StringToHGlobalAnsi(token);
      bool __retVal__L = Mq.MqServiceTokenExists(hdl, token_cstr);
      Marshal.FreeHGlobal(token_cstr);
      return __retVal__L;
    }

◆ ServiceTokenGet()

string csmqmsgque.MqContextC.ServiceTokenGet ( )

inline

C#: string ctx.ServiceTokenGet() → C-API
in an ongoing-service-call get the current MqContextC_ServiceApi_Identifer …

Definition at line 1702 of file MqContextC.cs.

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

Functions

Detailed Description

Function Documentation

◆ ServiceCreate() [1/3]

◆ ServiceCreate() [2/3]

◆ ServiceCreate() [3/3]

◆ ServiceDelete()

◆ ServiceIsTransaction()

◆ ServiceProxy()

◆ ServiceProxyCtx()

◆ ServiceProxyCtxExists()

◆ ServiceProxyRoundRobin()

◆ ServiceStorage()

◆ ServiceTokenCheck()

◆ ServiceTokenExists()

◆ ServiceTokenGet()