ProviewR Programmer's Reference Manual  V7.0.0
Functions

Functions

int sevcli_init (pwr_tStatus *sts, sevcli_tCtx *ctx)
 Initialization of the client. Creates a context and opens a Qcom queue for the communication. The function returns a context that is used in all subsequent sevcli calls. More...
 
int sevcli_close (pwr_tStatus *sts, sevcli_tCtx ctx)
 Close the communication. Removes the Qcom queue and frees the context. More...
 
void sevcli_set_servernid (sevcli_tCtx ctx, pwr_tNid nid)
 Set server from node id. This function is called to state which server node you want to communicate with. The server is stated with node identity.
 
int sevcli_set_servernode (pwr_tStatus *sts, sevcli_tCtx ctx, char *nodename)
 Set server from node name. This function is called to state which server node you want to communicate with. The server is stated with node name. More...
 
int sevcli_get_itemlist (pwr_tStatus *sts, sevcli_tCtx ctx, sevcli_sHistItem **list, unsigned int *cnt)
 Fetches a list with the stored attributes of the server. More...
 
int sevcli_get_itemdata (pwr_tStatus *sts, sevcli_tCtx ctx, pwr_tOid oid, char *aname, pwr_tTime starttime, pwr_tTime endtime, int numpoints, pwr_tTime **tbuf, void **vbuf, int *rows, pwr_eType *vtype, unsigned int *vsize)
 Fetch stored historical data for an attribute. More...
 
int sevcli_delete_item (pwr_tStatus *sts, sevcli_tCtx ctx, pwr_tOid oid, char *aname)
 Removes all data for a stored attribute in the storage database. More...
 
int sevcli_get_objectitemdata (pwr_tStatus *sts, sevcli_tCtx ctx, pwr_tOid oid, char *aname, pwr_tTime starttime, pwr_tTime endtime, int numpoints, pwr_tTime **tbuf, void **vbuf, int *rows, sevcli_sHistAttr **histattr, int *numattributes)
 Fetch stored historical data for an object item. More...
 
int sevcli_get_eventsitemlist (pwr_tStatus *sts, sevcli_tCtx ctx, sevcli_sEventsItem **list, unsigned int *cnt)
 Fetches a list with the stored eventlists of the server. More...
 
int sevcli_get_events (pwr_tStatus *sts, sevcli_tCtx ctx, pwr_tOid oid, pwr_tTime starttime, pwr_tTime endtime, pwr_tUInt32 eventtypemask, pwr_tUInt32 eventpriomask, pwr_tString80 eventtext, pwr_tOName eventname, unsigned int maxevents, sevcli_sEvents **list, unsigned int *cnt)
 Fetch stored historical events for an events item. More...
 
void sevcli_store_ctx (sevcli_tCtx ctx)
 Store context.
 
sevcli_tCtx sevcli_get_stored_ctx (void)
 Get stored context.
 

Detailed Description

Function Documentation

◆ sevcli_close()

int sevcli_close ( pwr_tStatus sts,
sevcli_tCtx  ctx 
)

Close the communication. Removes the Qcom queue and frees the context.

Returns
pwr_tStatus

Definition at line 86 of file rt_sevcli.c.

References qcom_DeleteQ(), and sevcli_sCtx::qid.

◆ sevcli_delete_item()

int sevcli_delete_item ( pwr_tStatus sts,
sevcli_tCtx  ctx,
pwr_tOid  oid,
char *  aname 
)

Removes all data for a stored attribute in the storage database.

Returns
pwr_tStatus

Definition at line 592 of file rt_sevcli.c.

References qcom_sQid::nid, sevcli_sCtx::qid, qcom_sQid::qix, and sevcli_sCtx::server.

◆ sevcli_get_events()

int sevcli_get_events ( pwr_tStatus sts,
sevcli_tCtx  ctx,
pwr_tOid  oid,
pwr_tTime  starttime,
pwr_tTime  endtime,
pwr_tUInt32  eventtypemask,
pwr_tUInt32  eventpriomask,
pwr_tString80  eventtext,
pwr_tOName  eventname,
unsigned int  maxevents,
sevcli_sEvents **  list,
unsigned int *  cnt 
)

Fetch stored historical events for an events item.

Returns
pwr_tStatus

Definition at line 748 of file rt_sevcli.c.

References qcom_sQid::nid, sevcli_sCtx::qid, qcom_sQid::qix, and sevcli_sCtx::server.

◆ sevcli_get_eventsitemlist()

int sevcli_get_eventsitemlist ( pwr_tStatus sts,
sevcli_tCtx  ctx,
sevcli_sEventsItem **  list,
unsigned int *  cnt 
)

Fetches a list with the stored eventlists of the server.

Returns
pwr_tStatus

Definition at line 658 of file rt_sevcli.c.

References qcom_sQid::nid, sevcli_sCtx::qid, qcom_sQid::qix, and sevcli_sCtx::server.

◆ sevcli_get_itemdata()

int sevcli_get_itemdata ( pwr_tStatus sts,
sevcli_tCtx  ctx,
pwr_tOid  oid,
char *  aname,
pwr_tTime  starttime,
pwr_tTime  endtime,
int  numpoints,
pwr_tTime **  tbuf,
void **  vbuf,
int *  rows,
pwr_eType *  vtype,
unsigned int *  vsize 
)

Fetch stored historical data for an attribute.

Returns
pwr_tStatus

Definition at line 357 of file rt_sevcli.c.

References qcom_sQid::nid, sevcli_sCtx::qid, qcom_sQid::qix, and sevcli_sCtx::server.

◆ sevcli_get_itemlist()

int sevcli_get_itemlist ( pwr_tStatus sts,
sevcli_tCtx  ctx,
sevcli_sHistItem **  list,
unsigned int *  cnt 
)

Fetches a list with the stored attributes of the server.

Returns
pwr_tStatus

Definition at line 156 of file rt_sevcli.c.

References qcom_sQid::nid, sevcli_sCtx::qid, qcom_sQid::qix, and sevcli_sCtx::server.

◆ sevcli_get_objectitemdata()

int sevcli_get_objectitemdata ( pwr_tStatus sts,
sevcli_tCtx  ctx,
pwr_tOid  oid,
char *  aname,
pwr_tTime  starttime,
pwr_tTime  endtime,
int  numpoints,
pwr_tTime **  tbuf,
void **  vbuf,
int *  rows,
sevcli_sHistAttr **  histattr,
int *  numattributes 
)

Fetch stored historical data for an object item.

Returns
pwr_tStatus

Definition at line 476 of file rt_sevcli.c.

References qcom_sQid::nid, sevcli_sCtx::qid, qcom_sQid::qix, and sevcli_sCtx::server.

◆ sevcli_init()

int sevcli_init ( pwr_tStatus sts,
sevcli_tCtx ctx 
)

Initialization of the client. Creates a context and opens a Qcom queue for the communication. The function returns a context that is used in all subsequent sevcli calls.

Returns
pwr_tStatus

Definition at line 62 of file rt_sevcli.c.

◆ sevcli_set_servernode()

int sevcli_set_servernode ( pwr_tStatus sts,
sevcli_tCtx  ctx,
char *  nodename 
)

Set server from node name. This function is called to state which server node you want to communicate with. The server is stated with node name.

Returns
pwr_tStatus

Definition at line 118 of file rt_sevcli.c.

References EVEN, qcom_sNode::name, qcom_sQid::nid, qcom_sNode::nid, qcom_MyNode(), sevcli_sCtx::qid, and sevcli_sCtx::server.