aspidsinash, aspidsinash_array, aspidsinash_local,
aspidsinash_server - enumerate processes in an array ses
sion
SYNOPSIS
#include <sys/types.h>
#include <arraysvcs.h>
aspidlist_t *aspidsinash(ash_t ASH);
asarraylist_t *aspidsinash_array(asserver_t Server,
const char *ArrayName, ash_t ASH);
aspidlist_t *aspidsinash_local(ash_t ASH);
asmachinelist_t *aspidsinash_server(asserver_t Server, ash_t ASH);
DESCRIPTION
The "aspidsinash" functions return lists of process IDs
that belong to the array session specified by the array
session handle ASH. Each function returns its list in a
data structure that is defined in <arraysvcs.h>. The
storage for these structures are allocated using mal
loc(3C), and should be released with the appropriate func
tion noted below when it is no longer needed.
The Server argument specifies an optional array server
token, which can be used to direct the request to a spe
cific array services daemon. If NULL is specified
instead, the request will be processed by the default
array services daemon if necessary (see array(1) for more
information on how the default array services daemon is
selected). For more details on creating an array server
token, see asopenserver(3X).
aspidsinash_local returns only those processes in the
array session that are running on the local machine. The
list of process IDs is returned in an aspidlist_t struc
ture, which may be freed using asfreepidlist(3X).
aspidsinash is the same as aspidsinash_local, and is
retained mainly for backward compatibility. Unlike the
remaining functions, aspidsinash_local and aspidsinash do
not require the array services daemon to be running in
order to complete successfully.
aspidsinash_server returns the list of processes in the
specified array session that are running on the machine
specified by Server. The list is returned in asma
chinepidlist_t, which may be freed using asfreema
chinepidlist(3X).
aspidsinash_array returns a list of processes in the spec
ified array session for all of the machines in the array
specified by ArrayName. The data is returned in the form
of an asarraypidlist_t, which may be freed using asfreear
raypidlist(3X). The asarraypidlist_t in turn contains
machine in the array. Each asmachinepidlist_t contains
the name of the particular machine and a list of the pro
cesses in the specified array session that are running
there.
NOTES
Notice that because processes and array sessions can come
and go over time, this information cannot be 100% accu
rate; it may omit some new processes and/or include pro
cesses that have already terminated.
All of the functions are found in the library "libar
ray.so", and will be loaded if the option "-larray" is
used with cc(1) or ld(1).
The array services daemon, arrayd(1M) must be running on
all affected machines for the functions aspidsinash_array
and aspidsinash_server to work properly.
SEE ALSO
asashisglobal(3X), aserrorcode(3X), asfreear
raypidlist(3X), asfreemachinepidlist(3X),
asfreepidlist(3X), aslistashs_server(3X), array_ses
sions(5).
DIAGNOSTICS
aspidsinash returns a pointer to an aspidlist_t structure
if successful or NULL if not. If unsuccessful, aserror
code will be set appropriately.
Man(1) output converted with
man2html