ProviewR Programmer's Reference Manual  V7.0.0
Classes | Functions
rt_qcom.h File Reference

Include file for QCOM Queue Communication. More...

#include <pthread.h>
#include <rpc/rpc.h>
#include "pwr_class.h"
#include "co_platform.h"
#include "rt_gdb_msg.h"

Go to the source code of this file.

Classes

struct  qcom_sQid
 Queue identity. More...
 
struct  qcom_sAid
 Application identity. More...
 
struct  qcom_sAppl
 Qcom application. More...
 
struct  qcom_sEvent
 Qcom event. More...
 
struct  qcom_sQattr
 Queue attributes. More...
 
struct  qcom_sType
 Qcom type. More...
 
struct  qcom_sPut
 Put data structure. More...
 
struct  qcom_sGet
 Get data structure. More...
 
union  qcom_mNode
 Node status. More...
 
struct  qcom_sNode
 Data for a Qcom node. More...
 

Functions

int qcom_AidCompare (const qcom_sAid *a1, const qcom_sAid *a2)
 Compare two application identities;. More...
 
pwr_tBoolean qcom_AidIsEqual (const qcom_sAid *a1, const qcom_sAid *a2)
 Test if two application identities are equal. More...
 
pwr_tBoolean qcom_AidIsNotEqual (const qcom_sAid *a1, const qcom_sAid *a2)
 Test if two application identities are different. More...
 
pwr_tBoolean qcom_AidIsNotNull (const qcom_sAid *a)
 Test if application identity is not null. More...
 
pwr_tBoolean qcom_AidIsNull (const qcom_sAid *a)
 Test if application identity is null. More...
 
void * qcom_Alloc (pwr_tStatus *sts, unsigned int size)
 Allocate a buffer in the qcom pool.
 
pwr_tBoolean qcom_AttachQ (pwr_tStatus *sts, const qcom_sQid *qid)
 Attach to an allready created queue.
 
pwr_tBoolean qcom_Bind (pwr_tStatus *sts, const qcom_sQid *myQ, const qcom_sQid *toQ)
 Bind one queue to another. More...
 
pwr_tBoolean qcom_CreateQ (pwr_tStatus *sts, qcom_sQid *myQ, qcom_sQattr *attr, const char *qname)
 Create a queue and make an implicit connect to it.
 
pwr_tBoolean qcom_DeleteQ (pwr_tStatus *sts, const qcom_sQid *myQ)
 Delete a queue. Delete a queue and release all resources held by the queue.
 
pwr_tBoolean qcom_WaitAnd (pwr_tStatus *status, const qcom_sQid *qid, const qcom_sQid *eid, int mask, int tmo)
 Wait for an event or a message. More...
 
pwr_tBoolean qcom_WaitOr (pwr_tStatus *status, const qcom_sQid *qid, const qcom_sQid *eid, int mask, int tmo, int *event)
 Wait for an event or a message. More...
 
pwr_tBoolean qcom_Exit (pwr_tStatus *sts)
 Disconnect from QCom. Disconnects an application from the Qcom message bus, all resources such as, queue, messages andbindings, held by the application will be released.
 
pwr_tBoolean qcom_Free (pwr_tStatus *sts, void *buffer)
 Free a previously allocated buffer.
 
pwr_tBoolean qcom_Init (pwr_tStatus *sts, qcom_sAid *aid, const char *aname)
 Connect to QCom. More...
 
void * qcom_Get (pwr_tStatus *sts, const qcom_sQid *myQ, qcom_sGet *get, int tmo_ms)
 Get a new message. More...
 
qcom_tBus qcom_MyBus (pwr_tStatus *sts)
 Get the current qcom bus number.
 
pwr_tBoolean qcom_MyNode (pwr_tStatus *sts, qcom_sNode *node)
 Get the local qcom node.
 
char * qcom_NodeName (pwr_tNodeId nid)
 Get the name of a qcom node.
 
pwr_tBoolean qcom_Node (pwr_tStatus *sts, qcom_sNode *node, pwr_tNodeId nid)
 Get qcom node from node identity.
 
pwr_tBoolean qcom_NextNode (pwr_tStatus *sts, qcom_sNode *node, pwr_tNodeId nid)
 Get the next qcom node. If nid is pwr_cNNodeId the first node is returned. More...
 
pwr_tBoolean qcom_Put (pwr_tStatus *sts, const qcom_sQid *receiver, qcom_sPut *put)
 Put a new message. More...
 
int qcom_QidCompare (const qcom_sQid *q1, const qcom_sQid *q2)
 Compare two queue identities;. More...
 
pwr_tBoolean qcom_QidIsEqual (const qcom_sQid *q1, const qcom_sQid *q2)
 Test if two queue identities are equal. More...
 
pwr_tBoolean qcom_QidIsNotEqual (const qcom_sQid *q1, const qcom_sQid *q2)
 Test if two queue identities are different. More...
 
pwr_tBoolean qcom_QidIsNull (const qcom_sQid *q)
 Test if queue identity is null. More...
 
pwr_tBoolean qcom_QidIsNotNull (const qcom_sQid *q)
 Test if queue identity is not null. More...
 
char * qcom_QidToString (char *s, qcom_sQid *qid, int prefix)
 Converts a queue identifier, 'qid' to a string. More...
 
pwr_tBoolean qcom_Reply (pwr_tStatus *sts, qcom_sGet *get, qcom_sPut *put)
 Reply to a qcom_Request. The qcom_Reply() call looks almost like a qcom_Put(), but the queue id is replaced with a qcom_sGet. Applications must agree on using qcom_Request/qcom_Reply, using a qcom_Put to reply on a qcom_Request will not work.
 
void * qcom_Request (pwr_tStatus *sts, const qcom_sQid *receiver, qcom_sPut *put, const qcom_sQid *myQ, qcom_sGet *get, int tmo_ms, pwr_tBitMask flags)
 Put a request and return the reply. More...
 
pwr_tBoolean qcom_Unbind (pwr_tStatus *sts, const qcom_sQid *myQ, const qcom_sQid *fromQ)
 Disconnect a target queue from a bound source queue. More...
 
void qcom_LinkConnect (pwr_tNodeId nid)
 
void qcom_LinkDisconnect (pwr_tNodeId nid)
 

Detailed Description

Include file for QCOM Queue Communication.

Definition in file rt_qcom.h.