Main Page | Modules | Namespace List | Class Hierarchy | Data Structures | Directories | File List | Namespace Members | Data Fields | Globals

IPC Definitions and API
[Private]

#define ALP_STATUS_ATTN_IPC_BAD_PARAM   (ALP_STATUS_ATTN_IPC | 0x00000100)
 Status definitions.
#define ALP_STATUS_ATTN_IPC_NO_MEMORY   (ALP_STATUS_ATTN_IPC | 0x00000200)
#define ALP_STATUS_ATTN_IPC_INTERNAL   (ALP_STATUS_ATTN_IPC | 0x00000300)
#define ALP_STATUS_ATTN_IPC_TIMEOUT   (ALP_STATUS_ATTN_IPC | 0x00000400)
#define ALP_ATTN_CALLBACK_CHANNEL_FORMAT   "alp-alert-callback-%d"
 Channel definitions.
#define ALP_ATTN_CALLBACK_CHANNEL_PROPERTY   "callback-channel"

Enumerations

enum  AlpAttnMsgID {
  ALP_ATTN_MSG_ID_STATUS = 1, ALP_ATTN_MSG_ID_STATUS_REPLY, ALP_ATTN_MSG_ID_POST, ALP_ATTN_MSG_ID_POST_REPLY,
  ALP_ATTN_MSG_ID_UPDATE, ALP_ATTN_MSG_ID_UPDATE_REPLY, ALP_ATTN_MSG_ID_DELETE, ALP_ATTN_MSG_ID_DELETE_REPLY,
  ALP_ATTN_MSG_ID_LOOKUP, ALP_ATTN_MSG_ID_LOOKUP_REPLY
}
 Message IDs for Attention Manager client IPC interface. More...
enum  AlpAttnMgrMsgID { ALP_ATTN_MGR_MSG_ID_QUERY = 1 }
 Message ID. More...

Functions

alp_status_t alp_attn_ipc_init (const char *channel)
const char * alp_attn_ipc_get_channel (void)
alp_status_t alp_attn_ipc_setup (void)
alp_status_t alp_attn_ipc_teardown (void)
alp_status_t alp_attn_ipc_send (AlpMessage *msg)
alp_status_t alp_attn_ipc_send_with_response (AlpMessage *msg, AlpMessage **response)
alp_status_t alp_attn_ipc_unpack_alert_post_msg (AlpMessage *message, AlpDmlItemH *itemH)
alp_status_t alp_attn_ipc_unpack_alert_post_reply (AlpMessage *response, alp_status_t *status, AlpAttnId *alertId)
alp_status_t alp_attn_ipc_unpack_alert_update_msg (AlpMessage *message, AlpDmlItemH *itemH)
alp_status_t alp_attn_ipc_unpack_alert_update_reply (AlpMessage *response, alp_status_t *status)
alp_status_t alp_attn_ipc_unpack_alert_delete_msg (AlpMessage *message, AlpDmlItemH *itemH)
alp_status_t alp_attn_ipc_unpack_alert_delete_reply (AlpMessage *response, alp_status_t *status)
alp_status_t alp_attn_ipc_unpack_status_reply_msg (AlpMessage *response, alp_status_t *status, gchar **srv_status)
AlpMessagealp_attn_ipc_pack_alert_post_msg (const char *source, const char *name, const char *handle, const char *interface, gint32 priority, gint32 duration, guint32 nprops, AlpAttnProp *props[], const char *channel)
 Create post alert IPC message.
AlpMessagealp_attn_ipc_pack_alert_post_reply (AlpMessage *replyTo, guint32 status, guint32 id)
 Create alert post IPC reply message.
AlpMessagealp_attn_ipc_pack_alert_update_msg (const char *source, const char *name, const char *handle, guint32 nprops, AlpAttnProp *props[])
 Create alert update IPC message.
AlpMessagealp_attn_ipc_pack_alert_update_reply (AlpMessage *replyTo, guint32 status)
 Create alert update IPC reply.
AlpMessagealp_attn_ipc_pack_alert_delete_msg (const char *source, const char *name, const char *handle)
 Create alert delete IPC message.
AlpMessagealp_attn_ipc_pack_alert_delete_reply (AlpMessage *replyTo, guint32 status)
 Create alert delete IPC message.
AlpMessagealp_attn_ipc_pack_status_reply (AlpMessage *replyTo, guint32 status, gchar *srv_status)
 Create status IPC reply message.
alp_status_t alp_attn_ipc_send_callback (const char *channel, const char *source, const char *name, const char *handle, uint32_t argc, char *argv[])


Define Documentation

#define ALP_ATTN_CALLBACK_CHANNEL_FORMAT   "alp-alert-callback-%d"
 

Channel definitions.

#define ALP_ATTN_CALLBACK_CHANNEL_PROPERTY   "callback-channel"
 

#define ALP_STATUS_ATTN_IPC_BAD_PARAM   (ALP_STATUS_ATTN_IPC | 0x00000100)
 

Status definitions.

#define ALP_STATUS_ATTN_IPC_INTERNAL   (ALP_STATUS_ATTN_IPC | 0x00000300)
 

#define ALP_STATUS_ATTN_IPC_NO_MEMORY   (ALP_STATUS_ATTN_IPC | 0x00000200)
 

#define ALP_STATUS_ATTN_IPC_TIMEOUT   (ALP_STATUS_ATTN_IPC | 0x00000400)
 


Enumeration Type Documentation

enum AlpAttnMgrMsgID
 

Message ID.

Enumerator:
ALP_ATTN_MGR_MSG_ID_QUERY 

enum AlpAttnMsgID
 

Message IDs for Attention Manager client IPC interface.

Enumerator:
ALP_ATTN_MSG_ID_STATUS  request server status string
ALP_ATTN_MSG_ID_STATUS_REPLY  response with server status string
ALP_ATTN_MSG_ID_POST  post alert request
ALP_ATTN_MSG_ID_POST_REPLY  post alert response
ALP_ATTN_MSG_ID_UPDATE  update alert properties request
ALP_ATTN_MSG_ID_UPDATE_REPLY  update alert properties response
ALP_ATTN_MSG_ID_DELETE  delete alert request
ALP_ATTN_MSG_ID_DELETE_REPLY  delete alert response
ALP_ATTN_MSG_ID_LOOKUP  lookup alert request
ALP_ATTN_MSG_ID_LOOKUP_REPLY  lookup alert response


Function Documentation

const char* alp_attn_ipc_get_channel void   ) 
 

alp_status_t alp_attn_ipc_init const char *  channel  ) 
 

AlpMessage* alp_attn_ipc_pack_alert_delete_msg const char *  source,
const char *  name,
const char *  handle
 

Create alert delete IPC message.

Parameters:
[in] identifier for alert to be updated
Returns:
pointer to message buffer if successful

NULL if packing of the message buffer failed

AlpMessage* alp_attn_ipc_pack_alert_delete_reply AlpMessage replyTo,
guint32  status
 

Create alert delete IPC message.

Parameters:
[in] replyTo original message being replied to
[in] status 
Returns:
pointer to message buffer if successful

NULL if packing of the message buffer failed

AlpMessage* alp_attn_ipc_pack_alert_post_msg const char *  source,
const char *  name,
const char *  handle,
const char *  interface,
gint32  priority,
gint32  duration,
guint32  nprops,
AlpAttnProp properties[],
const char *  channel
 

Create post alert IPC message.

Parameters:
[in] source alert source string
[in] name alert name string
[in] handle alert handle string
[in] priority integer priority of alert range 1 to 5
[in] duration integer duration of alert in number of seconds the alert should exist after being posted, 0 means indefinitely.
[in] nprops number of properties
[in] properties array of properties
Returns:
pointer to message buffer if successful

NULL if packing of the message buffer failed

AlpMessage* alp_attn_ipc_pack_alert_post_reply AlpMessage replyTo,
guint32  status,
guint32  id
 

Create alert post IPC reply message.

Parameters:
[in] replyTo original message being replied to
[in] status 
[in] id the identifier of the posted alert
Returns:
pointer to message buffer if successful

NULL if packing of the message buffer failed

AlpMessage* alp_attn_ipc_pack_alert_update_msg const char *  source,
const char *  name,
const char *  handle,
guint32  nprops,
AlpAttnProp properties[]
 

Create alert update IPC message.

Parameters:
[in] identifier for alert to be updated
[in] nprops number of properties
[in] properties array of properties
Returns:
pointer to message buffer if successful

NULL if packing of the message buffer failed

AlpMessage* alp_attn_ipc_pack_alert_update_reply AlpMessage replyTo,
guint32  status
 

Create alert update IPC reply.

Parameters:
[in] replyTo original message being replied to
[in] status 
Returns:
pointer to message buffer if successful

NULL if packing of the message buffer failed

AlpMessage* alp_attn_ipc_pack_status_reply AlpMessage replyTo,
guint32  status,
gchar *  srv_status
 

Create status IPC reply message.

Parameters:
[in] replyTo original message being replied to
[in] srv_status server status string
Returns:
pointer to message buffer if successful

NULL if packing of the message buffer failed

alp_status_t alp_attn_ipc_send AlpMessage msg  ) 
 

alp_status_t alp_attn_ipc_send_callback const char *  channel,
const char *  source,
const char *  name,
const char *  handle,
uint32_t  argc,
char *  argv[]
 

alp_status_t alp_attn_ipc_send_with_response AlpMessage msg,
AlpMessage **  response
 

alp_status_t alp_attn_ipc_setup void   ) 
 

alp_status_t alp_attn_ipc_teardown void   ) 
 

alp_status_t alp_attn_ipc_unpack_alert_delete_msg AlpMessage message,
AlpDmlItemH itemH
 

alp_status_t alp_attn_ipc_unpack_alert_delete_reply AlpMessage response,
alp_status_t status
 

alp_status_t alp_attn_ipc_unpack_alert_post_msg AlpMessage message,
AlpDmlItemH itemH
 

alp_status_t alp_attn_ipc_unpack_alert_post_reply AlpMessage response,
alp_status_t status,
AlpAttnId alertId
 

alp_status_t alp_attn_ipc_unpack_alert_update_msg AlpMessage message,
AlpDmlItemH itemH
 

alp_status_t alp_attn_ipc_unpack_alert_update_reply AlpMessage response,
alp_status_t status
 

alp_status_t alp_attn_ipc_unpack_status_reply_msg AlpMessage response,
alp_status_t status,
gchar **  srv_status
 


Generated on Sat Dec 16 20:29:50 2006 for hiker-0.9 by  doxygen 1.4.4