Advanced: Creating Customized OSIs : Customizing API Definitions : General API Definitions : Message APIs

Message APIs
 
Sample Definition
Message Data Type(nameid)
typedef $<CK_itsMessagesDataType > MESSAGE_$<nameid>;
Defines the code for the Type of a Message (OS Object).
Used for Data-Item which is defined to be a Message, to generate the type definition for the message.
Generated in the file type_def.h
For a Data-Item named DI_MSG, defined as a Message:
Design Attribute: CK_itsMessagesDataType = long int:
typedef long int MESSAGE_DI_MSG;
Declare Message(nameid)
DECLARE_MSG($<nameid>)
Defines the code for declaring a Message (OS Object).
Used when generating the code for declaring a Message.
The code is generated in the file type_def.h
For a Data-Item named DI_MSG, defined as a Message:
Define Message(nameid)
Defines the code for defining a Message (OS Object).
Used when generating the code for defining a Message.
The code is generated in the file glob_dat.c
For a Data-Item named DI_MSG, defined as a Message:
Create Message(nameid)
Defines the code for creating a Message (OS Object).
Used when generating the code for creating a Message
The code is generated in the file glob_dat.c, in the function: on_startup_code.
The function on_startup_code is called at the startup of the generated application.
For a Data-Item named DI_MSG, defined as a Message:
Destroy Message(nameid)
DESTROY_MSG($<nameid>)
Defines the code for destroying a Message (OS Object).
Used when generating the code for destroying a Message
The code is generated in the file glob_dat.c, in the function on_exit_code.
The function on_exit_code is called at the end of the generated application.
For a Data-Item named DI_MSG, defined as a Message:
Send Message(nameid)
Defines the code for sending a Message (OS Object).
This API's definition is used as the generated code for the operator "send" on a Data-Item defined to be a Message.
For a Data-Item named DI_MSG, defined as a Message:
Receive Message(nameid)
Defines the code for receiving a Message (OS Object).
This API's definition is used as the generated code for the operator "receive" on a Data-Item defined to be a Message
For a Data-Item named DI_MSG, defined as a Message: