Collaboration diagram for MqFactoryC_Class_C_API:

Topics
	MqFactoryC_Class_Define_C_API
	MqFactoryC - low level definition, access and cast …

Typedefs
typedef struct MqFactoryS *	MQ_FCT
	class-shortcut for `struct MqFactoryS *`, all shortcut using the `XX_YYY` syntax (only for public API) …

typedef const struct MqFactoryS *	MQ_FCTN
	class-shortcut for `const struct MqFactoryS `, all const* shortcut using the `XX_YYYC` syntax (only for public API) …

typedef struct MqFactoryS	MQ_FCTR
	reference-shortcut for `struct MqFactoryS`, all shortcut using the `XX_YYYR` syntax (only for public API) …

MqFactoryC - Export - inline - interact with an external software
MK_HDL	MqFactoryHandleGet_RT (MK_RT const mkrt, MQ_FCT const fct)
	Handle-Get-Slot - returns a *export-hdl* to the MqFactoryC useable for external storage

MQ_FCT	MqFactoryHandleResolve_RT (MK_RT const mkrt, MK_HDL const netHdl)
	Handle-Resolve-Slot - return a MqFactoryC from *netHdl* or `None` if invalid…

#define	MqFactoryHandleResolve_e(netHdl)
	wrapper for MqFactoryHandleResolve with error-handline

MqFactoryC - Misc - function - unspecified functions to perform different tasks
MQ_FCT	MqFactoryGetNull (void)
	Null-Slot - return a MqFactoryC typed `NULL` instance …

MqFactoryC - Introspection - inline - access to all instances created by class starting with the last one
MQ_FCT	MqFactoryInstances_RT (MK_RT_PARSER_ONLY)
	get head-instance from linked-list of MqFactoryS type …

MK_ATTR_HDL MQ_FCT	MqFactoryNext (MQ_FCT const fct)
	get next instance from linked-list of MqFactoryS type

MK_ATTR_HDL MQ_FCT	MqFactoryPrev (MQ_FCT const fct)
	get previous instance from linked-list of MqFactoryS type

MqFactoryC - Export - function
MQ_FCT	MqFactoryHandleResolveP (MK_RT const mkrt, MK_HDL const netHdl)
	Non-inline replacement for MqFactoryHandleResolve …

MK_HDL	MqFactoryHandleGetP (MK_RT const mkrt, MQ_FCT const fct)
	Non-inline replacement for MqFactoryHandleGet …

MqFactoryC - Introspection - function
MQ_FCT	MqFactoryNextP (MQ_FCT const fct)
	Non-inline replacement for MqFactoryNext …

MQ_FCT	MqFactoryPrevP (MQ_FCT const fct)
	Non-inline replacement for MqFactoryPrev …

MQ_FCT	MqFactoryInstancesP (MK_RT_PARSER_ONLY)
	Non-inline replacement for MqFactoryInstances …

MqFactoryC - Misc - function
MQ_FCT	MqFactoryGetNullP (void)
	Non-inline replacement for MqFactoryGetNull …

MqFactoryC - Export - overload
#define	MqFactoryHandleResolve_NULL(...)

#define	MqFactoryHandleResolve(...)

#define	MqFactoryHandleGet_NULL(...)

#define	MqFactoryHandleGet(...)

MqFactoryC - Introspection - overload
#define	MqFactoryInstances_NULL()

#define	MqFactoryInstances()

Detailed Description

MqFactoryC - define the class …

Macro Definition Documentation

◆ MqFactoryHandleGet

#define MqFactoryHandleGet ( ... )

Value:

MqFactoryHandleGet_RT(MK_RT_CALL __VA_ARGS__)

MK_RT_CALL

#define MK_RT_CALL

MqFactoryHandleGet_RT

MK_HDL MqFactoryHandleGet_RT(MK_RT const mkrt, MQ_FCT const fct)

Handle-Get-Slot - returns a export-hdl to the MqFactoryC useable for external storage

Definition LibMqMsgque_mq.h:3242

Definition at line 975 of file msgque_overload_mq.h.

◆ MqFactoryHandleGet_NULL

#define MqFactoryHandleGet_NULL ( ... )

Value:

MqFactoryHandleGet_RT(MK_RT_CALL_NULL __VA_ARGS__)

MK_RT_CALL_NULL

#define MK_RT_CALL_NULL

Definition at line 974 of file msgque_overload_mq.h.

◆ MqFactoryHandleResolve

#define MqFactoryHandleResolve ( ... )

Value:

MqFactoryHandleResolve_RT(MK_RT_CALL __VA_ARGS__)

MqFactoryHandleResolve_RT

MQ_FCT MqFactoryHandleResolve_RT(MK_RT const mkrt, MK_HDL const netHdl)

Handle-Resolve-Slot - return a MqFactoryC from netHdl or None if invalid…

Definition LibMqMsgque_mq.h:3259

Definition at line 971 of file msgque_overload_mq.h.

◆ MqFactoryHandleResolve_e

#define MqFactoryHandleResolve_e ( netHdl )

Value:

  ({ \
  MK_HDL tmpHdl=netHdl; \
  MQ_FCT tmp; \
  if (tmpHdl==0) { \
    tmp=NULL; \
  } else { \
    tmp=MqFactoryHandleResolve(tmpHdl); \
    if (tmp==NULL) { \
      MkErrorSetC_1_NULL("ERROR: 'MqFactoryC' handle is 'NULL'"); \
      goto error; \
    }; \
  }; \
  tmp; \
})

wrapper for MqFactoryHandleResolve with error-handline

Parameters

[in] netHdl The handle previously returned by MkObjectHandleGet.

Returns: Return an valid MQ_FCT or None with an error set.

If netHdl is None than None is returned and the upper-code decide how to deal with it.
MqFactoryHandleResolve return an valid MQ_FCT or None if the netHdl is invalid or the underlying object has already been deleted.
- If a None is returned than an error-message is created and a jump to the label error is done.
- If a MQ_FCT is returned than the netHdl is valid.

Definition at line 3275 of file LibMqMsgque_mq.h.

#define MqFactoryHandleResolve_e(netHdl) ({ \
  MK_HDL tmpHdl=netHdl; \
  MQ_FCT tmp; \
  if (tmpHdl==0) { \
    tmp=NULL; \
  } else { \
    tmp=MqFactoryHandleResolve(tmpHdl); \
    if (tmp==NULL) { \
      MkErrorSetC_1_NULL("ERROR: 'MqFactoryC' handle is 'NULL'"); \
      goto error; \
    }; \
  }; \
  tmp; \
})

◆ MqFactoryHandleResolve_NULL

#define MqFactoryHandleResolve_NULL ( ... )

Value:

MqFactoryHandleResolve_RT(MK_RT_CALL_NULL __VA_ARGS__)

Definition at line 970 of file msgque_overload_mq.h.

◆ MqFactoryInstances

#define MqFactoryInstances ( )

Value:

MqFactoryInstances_RT(MK_RT_CALL_ONLY)

MK_RT_CALL_ONLY

#define MK_RT_CALL_ONLY

MqFactoryInstances_RT

MQ_FCT MqFactoryInstances_RT(MK_RT_PARSER_ONLY)

get head-instance from linked-list of MqFactoryS type …

Definition LibMqMsgque_mq.h:9633

Definition at line 986 of file msgque_overload_mq.h.

◆ MqFactoryInstances_NULL

#define MqFactoryInstances_NULL ( )

Value:

MqFactoryInstances_RT(MK_RT_CALL_NULL_ONLY)

MK_RT_CALL_NULL_ONLY

#define MK_RT_CALL_NULL_ONLY

Definition at line 985 of file msgque_overload_mq.h.

Typedef Documentation

◆ MQ_FCT

typedef struct MqFactoryS* MQ_FCT

class-shortcut for struct MqFactoryS *, all shortcut using the XX_YYY syntax (only for public API) …

Definition at line 549 of file LibMqMsgque_mq.h.

◆ MQ_FCTN

typedef const struct MqFactoryS* MQ_FCTN

class-shortcut for const struct MqFactoryS *, all const shortcut using the XX_YYYC syntax (only for public API) …

Definition at line 552 of file LibMqMsgque_mq.h.

◆ MQ_FCTR

typedef struct MqFactoryS MQ_FCTR

reference-shortcut for struct MqFactoryS, all shortcut using the XX_YYYR syntax (only for public API) …

Definition at line 555 of file LibMqMsgque_mq.h.

Function Documentation

◆ MqFactoryGetNull()

MQ_FCT MqFactoryGetNull ( void )

inline

Null-Slot - return a MqFactoryC typed NULL instance …

Definition at line 3299 of file LibMqMsgque_mq.h.

                                             {
    return (MQ_FCT)MK_NULL;
  }

Here is the caller graph for this function:

◆ MqFactoryGetNullP()

MQ_FCT MqFactoryGetNullP ( void )

extern

Non-inline replacement for MqFactoryGetNull …

◆ MqFactoryHandleGet_RT()

MK_HDL MqFactoryHandleGet_RT	(	MK_RT const	mkrt,
		MQ_FCT const	fct )

inline

Handle-Get-Slot - returns a export-hdl to the MqFactoryC useable for external storage

The export-hdl is a reference to an instance that can be stored in software and converted back into an instance using the MqFactoryHandleResolve.

The export-hdl is only valid until the Programming-Language-Micro-Kernel (PLMK) ends.

example: The export-hdl is used in rpc to identify an object across the network.

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	fct	the MqFactoryS instance to work on

Returns: the required export-hdl

Definition at line 3242 of file LibMqMsgque_mq.h.

  {
  MK_RT_ATTR_HDL_CHECK(fct);
  return MkObjectHandleGet(MkOBJ(fct));
} MK_RT_ATTR_RUNTIME MK_RT_ATTR_HDL

◆ MqFactoryHandleGetP()

MK_HDL MqFactoryHandleGetP	(	MK_RT const	mkrt,
		MQ_FCT const	fct )

extern

Non-inline replacement for MqFactoryHandleGet …

◆ MqFactoryHandleResolve_RT()

MQ_FCT MqFactoryHandleResolve_RT	(	MK_RT const	mkrt,
		MK_HDL const	netHdl )

inline

Handle-Resolve-Slot - return a MqFactoryC from netHdl or None if invalid…

The MqFactoryHandleResolve undo the MqFactoryHandleGet and is intended to export a unique identifer into external code not belonging to the Programming-Language-Micro-Kernel (PLMK).

Parameters

[in]	mkrt	the MkRuntimeS instance to work on - the runtime argument, used by MK_RT_CALL (C-only)
[in]	netHdl	handle former exported with MqFactoryHandleGet

Returns: the required handle or None if netHdl is invalid

Definition at line 3259 of file LibMqMsgque_mq.h.

  {
  return MqFct(MkObjectHandleResolve(netHdl));
} MK_RT_ATTR_RUNTIME

◆ MqFactoryHandleResolveP()

MQ_FCT MqFactoryHandleResolveP	(	MK_RT const	mkrt,
		MK_HDL const	netHdl )

extern

Non-inline replacement for MqFactoryHandleResolve …

◆ MqFactoryInstances_RT()

MQ_FCT MqFactoryInstances_RT ( MK_RT_PARSER_ONLY )

inline

get head-instance from linked-list of MqFactoryS type …

The head-instance is the last instance created.

Definition at line 9633 of file LibMqMsgque_mq.h.

                                                            {
  MqRtSetup_NULL_RT;
  return (MQ_FCT)MqFactoryC_TT->instances;
}

◆ MqFactoryInstancesP()

MQ_FCT MqFactoryInstancesP ( MK_RT_PARSER_ONLY )

extern

Non-inline replacement for MqFactoryInstances …

◆ MqFactoryNext()

MK_ATTR_HDL MQ_FCT MqFactoryNext ( MQ_FCT const fct )

inline

get next instance from linked-list of MqFactoryS type

Definition at line 9640 of file LibMqMsgque_mq.h.

                                                 {
  MK_ATTR_HDL_CHECK(fct);
  return (MQ_FCT)MqFactoryC_X2obj(fct)->obj_protect.next;
} 

Here is the caller graph for this function:

◆ MqFactoryNextP()

MQ_FCT MqFactoryNextP ( MQ_FCT const fct )

extern

Non-inline replacement for MqFactoryNext …

◆ MqFactoryPrev()

MK_ATTR_HDL MQ_FCT MqFactoryPrev ( MQ_FCT const fct )

inline

get previous instance from linked-list of MqFactoryS type

Definition at line 9647 of file LibMqMsgque_mq.h.

                                                 {
  MK_ATTR_HDL_CHECK(fct);
  return (MQ_FCT)MqFactoryC_X2obj(fct)->obj_protect.prev;
} 

Here is the caller graph for this function:

◆ MqFactoryPrevP()

MQ_FCT MqFactoryPrevP ( MQ_FCT const fct )

extern

Non-inline replacement for MqFactoryPrev …

Topics

Typedefs

MqFactoryC - Export - inline - interact with an external software

MqFactoryC - Misc - function - unspecified functions to perform different tasks

MqFactoryC - Introspection - inline - access to all instances created by class starting with the last one

MqFactoryC - Export - function

MqFactoryC - Introspection - function

MqFactoryC - Misc - function

MqFactoryC - Export - overload

MqFactoryC - Introspection - overload

Detailed Description

Macro Definition Documentation

◆ MqFactoryHandleGet

◆ MqFactoryHandleGet_NULL

◆ MqFactoryHandleResolve

◆ MqFactoryHandleResolve_e

◆ MqFactoryHandleResolve_NULL

◆ MqFactoryInstances

◆ MqFactoryInstances_NULL

Typedef Documentation

◆ MQ_FCT

◆ MQ_FCTN

◆ MQ_FCTR

Function Documentation

◆ MqFactoryGetNull()

◆ MqFactoryGetNullP()

◆ MqFactoryHandleGet_RT()

◆ MqFactoryHandleGetP()

◆ MqFactoryHandleResolve_RT()

◆ MqFactoryHandleResolveP()

◆ MqFactoryInstances_RT()

◆ MqFactoryInstancesP()

◆ MqFactoryNext()

◆ MqFactoryNextP()

◆ MqFactoryPrev()

◆ MqFactoryPrevP()