Loading...
Searching...
No Matches
Functions
MqContextC_SendApi_Return_C_API
MQ_C_API » MqContextC_C_API » MqContextC_SendApi_C_API

MqContextC - finish the send-data-block on the server and optional return the results. … More...

+ Collaboration diagram for MqContextC_SendApi_Return_C_API:

Functions

MQ_EXTERN enum MkErrorE libmqmsgque::MqSendRETURN_RT (MK_RT const mkrt, MQ_CTX const ctx)
 MqContextC - finish the send-data-block on the server and optional return the results. …
 
MQ_EXTERN enum MkErrorE libmqmsgque::MqSendRETURN_SUB_RT (MK_RT const mkrt, MQ_CTX const ctx)
 return Sub-Data-Blocks required by MqSendEND_AND_SUB …
 
MQ_EXTERN enum MkErrorE libmqmsgque::MqSendERROR_RT (MK_RT const mkrt, MQ_CTX const ctx)
 send the data from the MkErrorC to the link target . …
 

MqContextC - MqContextC_SendApi_Return_C_API - overload

#define MqSendERROR_NULL(...)
 
#define MqSendERROR(...)
 
#define MqSendERROR_E(...)
 
#define MqSendERROR_C(...)
 
#define MqSendRETURN_NULL(...)
 
#define MqSendRETURN(...)
 
#define MqSendRETURN_E(...)
 
#define MqSendRETURN_C(...)
 
#define MqSendRETURN_SUB_NULL(...)
 
#define MqSendRETURN_SUB(...)
 
#define MqSendRETURN_SUB_E(...)
 
#define MqSendRETURN_SUB_C(...)
 

Detailed Description

MqContextC - finish the send-data-block on the server and optional return the results. …

Every service-handler have to use this function at the end to return the results or the error. If an error is returned the local MkErrorC is reset. The following behaviour is used:

Parameters
[in]mkrtthe MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]ctxthe MqContextS instance to work on
Exceptions
MkExceptionC→ The default-exception from the Programming-Language-Micro-Kernel (PLMK)

Macro Definition Documentation

◆ MqSendERROR

#define MqSendERROR ( ...)
Value:
MqSendERROR_RT(MK_RT_CALL __VA_ARGS__)
MK_RT_CALL
#define MK_RT_CALL

Definition at line 699 of file msgque_overload_mq.h.

◆ MqSendERROR_C

#define MqSendERROR_C ( ...)
Value:
if (MkErrorCheckI(MqSendERROR(__VA_ARGS__)))
MqSendERROR
#define MqSendERROR(...)
Definition msgque_overload_mq.h:699

Definition at line 701 of file msgque_overload_mq.h.

◆ MqSendERROR_E

#define MqSendERROR_E ( ...)
Value:
MkErrorCheck(MqSendERROR(__VA_ARGS__))

Definition at line 700 of file msgque_overload_mq.h.

◆ MqSendERROR_NULL

#define MqSendERROR_NULL ( ...)
Value:
MqSendERROR_RT(MK_RT_CALL_NULL __VA_ARGS__)
MK_RT_CALL_NULL
#define MK_RT_CALL_NULL

Definition at line 698 of file msgque_overload_mq.h.

◆ MqSendRETURN

#define MqSendRETURN ( ...)
Value:
MqSendRETURN_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 703 of file msgque_overload_mq.h.

◆ MqSendRETURN_C

#define MqSendRETURN_C ( ...)
Value:
if (MkErrorCheckI(MqSendRETURN(__VA_ARGS__)))
MqSendRETURN
#define MqSendRETURN(...)
Definition msgque_overload_mq.h:703

Definition at line 705 of file msgque_overload_mq.h.

◆ MqSendRETURN_E

#define MqSendRETURN_E ( ...)
Value:
MkErrorCheck(MqSendRETURN(__VA_ARGS__))

Definition at line 704 of file msgque_overload_mq.h.

◆ MqSendRETURN_NULL

#define MqSendRETURN_NULL ( ...)
Value:
MqSendRETURN_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 702 of file msgque_overload_mq.h.

◆ MqSendRETURN_SUB

#define MqSendRETURN_SUB ( ...)
Value:
MqSendRETURN_SUB_RT(MK_RT_CALL __VA_ARGS__)

Definition at line 707 of file msgque_overload_mq.h.

◆ MqSendRETURN_SUB_C

#define MqSendRETURN_SUB_C ( ...)
Value:
if (MkErrorCheckI(MqSendRETURN_SUB(__VA_ARGS__)))
MqSendRETURN_SUB
#define MqSendRETURN_SUB(...)
Definition msgque_overload_mq.h:707

Definition at line 709 of file msgque_overload_mq.h.

◆ MqSendRETURN_SUB_E

#define MqSendRETURN_SUB_E ( ...)
Value:
MkErrorCheck(MqSendRETURN_SUB(__VA_ARGS__))

Definition at line 708 of file msgque_overload_mq.h.

◆ MqSendRETURN_SUB_NULL

#define MqSendRETURN_SUB_NULL ( ...)
Value:
MqSendRETURN_SUB_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 706 of file msgque_overload_mq.h.

Function Documentation

◆ MqSendERROR_RT()

MQ_EXTERN enum MkErrorE libmqmsgque::MqSendERROR_RT ( MK_RT const mkrt,
MQ_CTX const ctx )

send the data from the MkErrorC to the link target . …

If an error is available the error-number and the error-text is send to the link target. After send the error is reset. This function only raise an error if the sending self fails or the MkErrorDEFAULT is set and the ctx is a client-context.

Parameters
[in]mkrtthe MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]ctxthe MqContextS instance to work on
Exceptions
MkExceptionC→ The default-exception from the Programming-Language-Micro-Kernel (PLMK)

◆ MqSendRETURN_RT()

MQ_EXTERN enum MkErrorE libmqmsgque::MqSendRETURN_RT ( MK_RT const mkrt,
MQ_CTX const ctx )

MqContextC - finish the send-data-block on the server and optional return the results. …

Every service-handler have to use this function at the end to return the results or the error. If an error is returned the local MkErrorC is reset. The following behaviour is used:

  • if a shortterm transaction is ongoing this function return the data or the error to the link target
  • if the answer does not return any data no previous MqSendSTART is required.
  • if no transaction is ongoing this function does just return. If an error is available report an asynchronous error to the link target.
Parameters
[in]mkrtthe MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]ctxthe MqContextS instance to work on
Exceptions
MkExceptionC→ The default-exception from the Programming-Language-Micro-Kernel (PLMK)

◆ MqSendRETURN_SUB_RT()

MQ_EXTERN enum MkErrorE libmqmsgque::MqSendRETURN_SUB_RT ( MK_RT const mkrt,
MQ_CTX const ctx )

return Sub-Data-Blocks required by MqSendEND_AND_SUB …

Every service-handler CAN use this function at the end of a data block if the caller used MqSendEND_AND_SUB to initiate the service call. MqSendEND_AND_SUB will block until ithe final ctx.SendRETURN() was send.

Parameters
[in]mkrtthe MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]ctxthe MqContextS instance to work on
Exceptions
MkExceptionC→ The default-exception from the Programming-Language-Micro-Kernel (PLMK)
Generated on Wed Sep 25 2024 12:15:49 for theLink by doxygen 1.13.0