MqSetupS Struct Reference
[PUBLIC: object configuration]
application-programmer configuration data
More...
#include <src/msgque.h>
Data Fields | |
| struct MqLinkSetupS | Child |
| setup/cleanup a CHILD object | |
| struct MqLinkSetupS | Parent |
| setup/cleanup a PARENT object | |
| struct MqCallbackS | FilterFTR |
| pointer to the Filter stream-data service | |
| struct MqCallbackS | FilterEOF |
| pointer to the Filter EndOfFile service | |
| struct MqCallbackS | BgError |
| pointer to the background error service | |
| MQ_BOL | isServer |
| Create a server context. | |
| struct MqCallbackS | ServerSetup |
| pointer to the Server-Setup function | |
| struct MqCallbackS | ServerCleanup |
| pointer to the Server-Cleanup function | |
| MqEventF | fEvent |
| Create a link to the calling tool event-handling queue. | |
| struct MqFactoryS | Factory |
| function pointers used to create and delete an object or a class instance | |
| MqSetupF | fThreadInit |
| setup and initialize a thread befor a new thread is created by libmsgque | |
| MqSetupF | fForkInit |
| setup and initialize a fork-process befor a new fork-process is created by libmsgque | |
| MqExitF | fProcessExit |
| exit/cleanup a process | |
| MqExitF | fThreadExit |
| exit/cleanup a thread | |
| MqHelpF | fHelp |
| Create a link to the calling tool help function. | |
Detailed Description
application-programmer configuration dataDefinition at line 747 of file msgque.h.
Field Documentation
struct MqCallbackS MqSetupS::BgError [read] |
pointer to the background error service
A background error is an error without an link to an workflow. The error happen if an MqSendEND call fails or if an othe asyncrone task fails. if the callback is not specified the error is printed to stderr but no error if left in the context. if the callback is defiend the context is set to the error and the callback is called to process this error. On the callback the error can be cleared up with MqErrorReset.
struct MqLinkSetupS MqSetupS::Child [read] |
setup/cleanup a CHILD object
- Attention:
- always call this functions using MqLinkCreate and MqLinkDelete
struct MqFactoryS MqSetupS::Factory [read] |
function pointers used to create and delete an object or a class instance
| type | default | option | application | context |
|---|---|---|---|---|
| DATA | NULL | NO | server/client | parent |
The factory pattern is used to:
- create a new object (C, TCL) or a new class instance (C++, C#, JAVA, PYTHON, PERL, VB.NET)
- create a server-child object
- create a server-parent object using the --thread startup qualification
- create a slave-worker-parent object
- create a slave-child object
- create a filter-parent object using the --fork or --thread startup qualification
Create a link to the calling tool event-handling queue.
| type | default | option | application | context |
|---|---|---|---|---|
| POINTER | NULL | NO | server/client | parent |
Event-Handling is used to process instructions in the background to give the tool-user the feeling of a non-blocking application. For Example Tcl using the event-handling to update the Tk user-interface while the application is waiting for data. The event-handling is usually a loop to check event-sources from time-to-time and act on incoming events.
Create a link to the calling tool help function.
| type | default | option | application | context |
|---|---|---|---|---|
| POINTER | NULL | NO | server/client | parent |
As a service to the programmer the libmsgque startup code in MqLinkCreate checks for the both options -h and --help to provide a tool-specific help-page and exit.
struct MqCallbackS MqSetupS::FilterEOF [read] |
pointer to the Filter EndOfFile service
A service function to act on End-Of-Filter data. This service is called after the whole filter data was send. Sometimes the filter data can not be served as filter data rows (example: sorting of the input rows need to read all rows before the data can be send to the next filter command) and the EOF function is used to continue send filter data rows.
struct MqCallbackS MqSetupS::FilterFTR [read] |
pointer to the Filter stream-data service
A service function to act on filter data rows. Every filter input data is a list of filter data rows and every row is a list of filter data columns. Every row is send from one filter-command to the following filter-command as FTR service request
Create a server context.
| type | default | option | application | context |
|---|---|---|---|---|
| BOOL | NO | NO | server | parent |
If the server option is available the MqLinkCreate will create an libmsgque object usable as a server. For detail information read: WHAT-IS: parent versa child
struct MqLinkSetupS MqSetupS::Parent [read] |
setup/cleanup a PARENT object
- Attention:
- always call this functions using MqLinkCreate and MqLinkDelete
struct MqCallbackS MqSetupS::ServerCleanup [read] |
pointer to the Server-Cleanup function
This Server-Cleanup function is used to cleanup a server-context-link and act like a destructor. The function is called on the begin of MqLinkDelete.
struct MqCallbackS MqSetupS::ServerSetup [read] |
pointer to the Server-Setup function
This Server-Setup function is used to configure a new server-link and act like a constructor. This function is called on the end of MqLinkCreate. A server-context-link is created for every new incomming connection request and is used to provide context specific services .
The documentation for this struct was generated from the following file:
