| Previous | Contents | Index |
Note that some entity tables may contain rows with inactive data, that is, data for processes that are no longer active. The data in these rows may or may not be interesting to the caller. To distinguish active and inactive processes, the Remote Manager sets the record_state field to MGMT_VALID for active processes and to MGMT_INACTIVE for inactive processes. The caller is responsible for checking this field and taking appropriate action.
The collection_states field is a simple array of five integers. Each array element contains either a 1 (if the collection class is enabled) or a 0 (if the collection class is disabled). Array elements are positional, as described in the Return Value section.
Like other procedures that return linked lists (see Section 6.6.1 for a detailed example of linked-list processing), the return parameter is a union containing either a failure status code or a linked list of records.
To determine the status of the call and the contents of the return record, first check the status field. The following are possible values in the status field:
If the status field value is MGMT_SUCCESS, a linked list has been returned. The linked list contains a structure containing the process data, and a forward pointer. By following the forward pointer, all the records in the list can be retrieved.
If the ACMS run-time system is not running when this call is issued, the Remote Manager returns the MGMT_NOT_MAPPED error code.
int list_process_data(int client_id,CLIENT *cl)
{
proc_data_list *proc;
proc_link *nl;
static struct sub_id_struct sub_rec;
int status;
sub_rec.client_id = client_id;
proc = acmsmgmt_list_proc_1(&sub_rec,cl);
if (!proc) {
printf("\n RPC Call to get Process data failed");
return(MGMT_FAIL);
}
if ((proc->status != MGMT_SUCCESS) && (proc->status != MGMT_NOMORE_DATA)) {
printf("\n Call to get Process data failed, returning status code %d",
proc->proc_data_list_u.rc);
status = proc->proc_data_list_u.rc;
xdr_free(xdr_proc_data_list, proc);
free(proc);
return(status);
}
for (nl = proc->proc_data_list_u.list; nl != NULL; nl = nl->pNext) {
if (nl->proc_data.record_state == MGMT_INACTIVE)
printf("\n INACTIVE ");
else
printf("\n ");
printf(" PID: %8X Process Name: %s",nl->proc_data.pid,
nl->proc_data.process_name);
}
printf("\n End of data");
xdr_free(xdr_proc_data_list, proc);
free(proc);
return(0);
}
|
In the preceding example, the ACMSMGMT_LIST_PROC_1 procedure is called to fetch information about collection states from all processes accessible to the Remote Manager. If the call succeeds, the name of the process, along with its state is displayed (inactive processes have that string printed before the process name). Otherwise, an error message is displayed. The example in Section 6.4.1 shows how to declare and initialize the input arguments to this procedure.
8.24 ACMSMGMT_LIST_SERVER_1
ACMS Remote Manager clients call this procedure to obtain a list of
procedure server table (Server table) entries.
ser_data_list *acmsmgmt_list_server_1(ser_sel_struct *sub_rec, CLIENT *cl)
sub_rec
Type: Ser_sel_struct Access: Read Mechanism: By reference Usage: Structure that contains client information and procedure server selection criteria. The structure contains the following fields. client_id Type: Integer Access: Read Mechanism: By value Usage: If explicit authentication is being used, a valid client ID must be provided. If the value for client_id is 0, proxy access is used. Client_id is obtained by calling the acms$mgmt_get_creds procedure. appl_name Type: Null-terminated string Access: Read Mechanism: By reference Usage: A pointer to an application name. The name may contain wildcard characters (*, !). Specify in all uppercase characters. server_name Type: Null-terminated string Access: Read Mechanism: By reference Usage: A pointer to a procedure server name. The name may contain wildcard characters (*, !). Specify in all uppercase characters. cl
Type: CLIENT * Access: Read Mechanism: By value Usage: Pointer to an RPC client handle previously obtained by calling the RPC routine CLNT_CREATE.
Type: Ser_data_list Access: Write Mechanism: By reference Usage: Pointer to a record that contains a union consisting of either a failure code or a pointer to a structure of type ser_link, which contains the start of a linked list of records. The following are the contents of this union: rc Type: Integer Access: Write Mechanism: By value Usage: Failure return code. list Type: Ser_list Access: Write Mechanism: By reference Usage: Start of linked list. Pointer to a structure containing an EXC table record, and a forward pointer to the next node in the linked list. The following are the contents of this structure: pNext Type: Ser_list Access: Write Mechanism: By value Usage: Start of linked list. Pointer to a structure of type coll_list. ser_data Type: Ser_rec_r Access: Write Mechanism: By reference Usage: Server table row. Server table fields are described in Section 9.11.
The ACMSMGMT_LIST_SER_1 procedure returns a linked list of Server table rows. All matching Server table rows are returned in each call. Matching is performed first on application name, and then on server name. Therefore, all matching servers for all matching applications are returned.Entire table rows are returned. See Section 9.11 for a description of the fields in the ser_rec_r structure.
If the ACMS run-time system is not running when this call is issued, the Remote Manager returns the MGMT_NOT_MAPPED error code.
Rows in the EXC table are subject to reuse. Rows are assigned round-robin, and are not cleared until they have been reassigned. Therefore, some rows may contain data for inactive EXCs. The Remote Manager attempts to retrieve server information for inactive EXCs. It is the caller's responsibility to examine the record_state field to determine whether this row belongs to an active (record_state field is MGMT_VALID) or inactive (record_state field is MGMT_INACTIVE) EXC, and to process the row accordingly.
int list_ser_data(int client_id,CLIENT *cl)
{
static char c_all_appls[2] = "*";
ser_data_list *ser_data;
ser_link *nl;
static struct ser_sel_struct sub_rec;
int status;
sub_rec.client_id = client_id;
sub_rec.appl_name = c_all_appls;
sub_rec.server_name = c_all_appls;
ser_data = acmsmgmt_list_server_1(&sub_rec,cl);
if (!ser_data) {
printf("\n RPC Call to get Server data failed");
return(MGMT_FAIL);
}
if (ser_data->status == MGMT_FAIL) {
if (ser_data->ser_data_list_u.rc == MGMT_NOMORE_DATA) {
printf("\n No SERVER data found");
xdr_free(xdr_ser_data_list, ser_data);
free(ser_data);
return(MGMT_FAIL);
}
printf("\n Call to get Server data failed, returning status code %d",
ser_data->ser_data_list_u.rc);
status = ser_data->ser_data_list_u.rc;
xdr_free(xdr_ser_data_list, ser_data);
free(ser_data);
return(status);
}
if (ser_data->status == MGMT_WARN)
printf("\n ** Warning, some data may be from inactive processes **");
for (nl = ser_data->ser_data_list_u.list; nl != NULL; nl = nl->pNext) {
if (nl->ser_data.record_state == MGMT_INACTIVE)
printf("\n INACTIVE ");
else
printf("\n ");
printf(" Application : %-32s Server: %-s",
nl->ser_data.appl_name,
nl->ser_data.server_name);
}
printf("\n End of data");
xdr_free(xdr_ser_data_list, ser_data);
free(ser_data);
return(0);
}
|
In the preceding example, the ACMSMGMT_LIST_SERVER_1 procedure is called to fetch the contents of the Server tables for all applications on the target node. If the call succeeds, the state of the server (if inactive), the name of the application it belongs to, and the name of the server are displayed for each table row returned. Otherwise, an error message is displayed. The example in Section 6.4.1 shows how to declare and initialize the input arguments to this procedure.
8.25 ACMSMGMT_LIST_TG_2
ACMS Remote Manager clients call this procedure to obtain a list of
Task Group table entries.
tg_data_list_2 *acmsmgmt_list_tg_2(tg_sel_struct *sub_rec, CLIENT *cl)
sub_rec
Type: Tg_sel_struct Access: Read Mechanism: By reference Usage: Structure that contains client information and task group selection critera. The structure contains the following fields. client_id Type: Integer Access: Read Mechanism: By value Usage: If explicit authentication is being used, a valid client ID must be provided. If the value for client_id is 0, proxy access is used. Client_id is obtained by calling the acms$mgmt_get_creds procedure. appl_name Type: Null-terminated string Access: Read Mechanism: By reference Usage: A pointer to an application name. The name may contain wildcard characters (*, !). Specify in all uppercase characters. tg_name Type: Null-terminated string Access: Read Mechanism: By reference Usage: A pointer to a task group name. The name may contain wildcard characters (*, !). Specify in all uppercase characters. cl
Type: CLIENT * Access: Read Mechanism: By value Usage: Pointer to an RPC client handle previously obtained by calling the RPC routine CLNT_CREATE.
Type: Tg_data_list_2 Access: Write Mechanism: By reference Usage: Pointer to a record that contains a union consisting of either a failure code or a pointer to a structure of type tg_link_2, which contains the start of a linked list of records. The following are the contents of this union: rc Type: Integer Access: Write Mechanism: By value Usage: Failure return code. list Type: Tg_list_2 Access: Write Mechanism: By reference Usage: Start of linked list. Pointer to a structure containing a Task Group table record, and a forward pointer to the next node in the linked list. The following are the contents of this structure: pNext Type: Tg_list_2 Access: Write Mechanism: By value Usage: Start of linked list. Pointer to a structure of type coll_list. tg_data Type: Tg_rec_r_2 Access: Write Mechanism: By reference Usage: Task Group table row. Task Group table fields are described in Section 9.12.
The ACMSMGMT_LIST_TG_2 procedure returns a linked list of Task Group table rows. All matching Task Group table rows are returned in each call. Matching is performed first on the application name, and then on the task group name. Therefore, all matching task groups for all matching applications are returned.Entire table rows are returned. See Section 9.12 for a description of the fields in the tg_rec_r structure.
If the ACMS run-time system is not running when this call is issued, the Remote Manager returns the MGMT_NOT_MAPPED error code.
Rows in the EXC table are subject to reuse. Rows are assigned round-robin, and are not cleared until they have been reassigned. Therefore, some rows may contain data for inactive EXCs. The Remote Manager will attempt to retrieve task group information for inactive EXCs. It is the caller's responsibility to examine the record_state field to determine whether this row belongs to an active (record_state field is MGMT_VALID) or inactive (record_state field is MGMT_INACTIVE) EXC, and to process the row accordingly.
int list_group_data(int client_id,CLIENT *cl)
{
static char c_all_appls[2] = "*";
tg_data_list_2 *tg_data;
tg_link_2 *nl;
static struct tg_sel_struct sub_rec;
int status;
sub_rec.client_id = client_id;
sub_rec.appl_name = c_all_appls;
sub_rec.tg_name = c_all_appls;
tg_data = acmsmgmt_list_tg_2(&sub_rec,cl);
if (!tg_data) {
printf("\n RPC Call to get Task Group data failed");
return(MGMT_FAIL);
}
if (tg_data->status == MGMT_FAIL) {
if (tg_data->tg_data_list_2_u.rc == MGMT_NOMORE_DATA) {
printf("\n No GROUP data found");
xdr_free(xdr_tg_data_list_2, tg_data);
free(tg_data);
return(MGMT_FAIL);
}
printf("\n Call to get Task Group data failed, returning status code
%d",tg_data->tg_data_list_2_u.rc);
status = tg_data->tg_data_list_2_u.rc;
xdr_free(xdr_tg_data_list_2, tg_data);
free(tg_data);
return(status);
}
if (tg_data->status == MGMT_WARN)
printf("\n ** Warning, some data may be from inactive processes **");
for (nl = tg_data->tg_data_list_2_u.list; nl != NULL; nl = nl->pNext) {
if (nl->tg_data.record_state == MGMT_INACTIVE)
printf("\n INACTIVE ");
else
printf("\n ");
printf(" Application: %-32s Task Group: %-s",
nl->tg_data.appl_name,
nl->tg_data.tg_name);
}
printf("\n End of data");
xdr_free(xdr_tg_data_list_2, tg_data);
free(tg_data);
return(0);
}
|
In the preceding example, the ACMSMGMT_LIST_TG_1 procedure is called to fetch the contents of the Task Group tables for all applications on the target node. If the call succeeds, the state of the task group (if inactive), the name of the application it belongs to, and the name of the task group are displayed for each table row returned. Otherwise, an error message is displayed. The example in Section 6.4.1 shows how to declare and initialize the input arguments to this procedure.
| Previous | Next | Contents | Index |