Content-type: text/html Manpage of psrplib

psrplib

Section: C Library Functions (3)
Updated: 15 August 2000
Index Return to Main Contents

NAME

psrp_ignore_requests, psrp_accept_requests, psrp_load_dispatch_table, psrp_init, psrp_load_default_dispatch_table, psrp_find_action_slot_index, psrp_get_action_slot_index, psrp_attach_static_databag, psrp_attach_dynamic_databag, psrp_attach_shared_heap, psrp_attach_static_function, psrp_show_object_list, psrp_reset_dispatch_table, psrp_detach_object_by_name, psrp_detach_object_by_handle, empty_fifo, psrp_chbrk_handler, psrp_save_dispatch_table, psrp_exit, lookup_psrp_object_by_name, lookup_psrp_object_by_handle, psrp_std_init, psrp_t_arg_errs, psrp_ostate, psrp_destroy_object, psrp_error, psrp_pname_to_pid, psrp_pnames_to_pidlist, psrp_pid_to_pname, psrp_channelname_to_pid, psrp_pid_to_channelname, psrp_show_shared_heaps, psrp_show_open_sics, psrp_create_slaved_interaction_client, psrp_slaved_client_transaction, psrp_destroy_slaved_interaction_client, psrp_assign_stdio, psrp_assign_fstdio, psrp_wait_for_data, psrp_get_tag_index, psrp_ifree_tag_list, psrp_isearch_tag_list, psrp_alias, psrp_unalias, psrp_show_aliases, psrp_new_instance, psrp_channel_locked, psrp_new_segment, psrp_get_server_host, psrp_prod_host, psrp_authenticate, psrp_set_server_password, psrp_write_sic, psrp_read_sic, psrp_int_sic, psrp_set_client_exitf, psrp_reset_client_exitf, psrp_overlay_server_process, psrp_crontab_schedule, psrp_crontab_unschedule, psrp_crontab_init, psrp_show_crontab

SYNOPSIS

void psrp_ignore_requests(void);
void psrp_accept_requests(void);
int psrp_load_dispatch_table
(
       int search,

       FILE *stream,

       char *autoload_file_name

);
void psrp_init
(
       int bind_status,

       int (*psrp_process_status)(int,char *argv[])

);
int psrp_load_default_dispatch_table(FILE *stream);
int psrp_find_action_slot_index(char *object_tag);
int psrp_get_action_slot_index(void);
int psrp_attach_static_databag
(
       FILE *stream,

       char *object_tag,

       long databag_size,

       unsigned char *databag_handle

);
int psrp_attach_dynamic_databag
(
       int search,

       FILE *stream,

       char *object_tag,

       char *bag_file_name,

       int h_mode

);
int psrp_attach_shared_heap
(
       int search,

       FILE *stream,

       char *heap_tag,

       char *heap_file_name,

       int h_mode

);
int psrp_attach_static_function
(
       FILE *stream,

       char *object_tag,

       void *object_handle

);
void psrp_show_object_list(void);
void psrp_reset_dispatch_table(FILE *stream);
int psrp_detach_object_by_name
(
       FILE *stream,

       char *object_tag

);
int psrp_detach_object_by_handle
(
       FILE *stream,

       void *object_handle

);
void empty_fifo(int fd);
int psrp_chbrk_handler
(
       int index,

       int event,

       char *event_info

);
int psrp_save_dispatch_table
(
       FILE *stream,

       char *autoload_file_name

);
void psrp_exit(void);
int lookup_psrp_object_by_name(char *name);
int lookup_psrp_object_by_handle(void *object_handle);
int psrp_std_init
(
       int argc,

       char *argv[]

);
int psrp_t_arg_errs
(
       int argc,

       int argd[],

       char *args[]

);
int psrp_ostate(char *object_tag);
void psrp_destroy_object(int index);
void psrp_error(char *error_string);
int psrp_pname_to_pid(char *process_name);
int psrp_pnames_to_pidlist
(
       int n_procs,

       char *process_name[],

       int *n_pids,

       int *pid_list,

       char *pid_name[]

);
int psrp_pid_to_pname
(
       int pid,

       char *process_name

);
int psrp_channelname_to_pid
(
       char *patchboard_path,

       char *process_name,

       char *process_host

);
int psrp_pid_to_channelname
(
       char *patchboard_path,

       int pid,

       char *process_name,

       char *process_host

);
void psrp_show_shared_heaps(FILE *stream);
void psrp_show_open_sics(FILE *stream);
psrp_channel_type *psrp_create_slaved_interaction_client
(
       FILE *stream,

       char *host_name,

       char *psrp_pen,

       char *channel_name

);
int psrp_slaved_client_transaction
(
       char *request,

       char *reply,

       int *reply_length,

       psrp_channel_type *channel

);
psrp_channel_type *psrp_destroy_slaved_interaction_client
(
       FILE *stream,

       psrp_channel_type *channel

);
int psrp_assign_stdio
(
       FILE *psrp_out,

       int *argc,

       char *argv[],

       int *in_des,

       int *out_des,

       int *err_des

);
int psrp_assign_fstdio
(
       FILE *psrp_out,

       int *argc,

       char *argv[],

       FILE *in_stream,

       FILE *out_stream,

       FILE *err_stream

);
int psrp_wait_for_data(int des);
int psrp_get_tag_index(int index);
int psrp_ifree_tag_list(int index);
int psrp_isearch_tag_list
(
       char *object_tag,

       int index

);
int psrp_alias
(
       FILE *stream,

       char *name,

       char *alias

);
int psrp_unalias
(
       FILE *stream,

       char *alias,

       char *base_tag_name

);
int psrp_show_aliases(char *basename);
int psrp_new_instance
(
       FILE *stream,

       int t_c_instance,

       char *instance_name,

       char *host

);
int psrp_channel_locked
(
       FILE *stream,

       char *channel_name

);
int psrp_new_segment
(
       char *name,

       char *host,

       int lock_channel

);
int psrp_get_server_host
(
       FILE *stream,

       char *server,

       char host_list[][256]

);
int psrp_prod_host
(
       FILE *stream,

       char *hostname,

       char *password,

       char *psrp_server,

       int max_trys,

       int *server_pid

);
int psrp_authenticate(char *password);
int psrp_set_server_password(FILE *stream);
int psrp_write_sic
(
       psrp_channel_type *sic,

       char *request

);
int psrp_read_sic
(
       psrp_channel_type *sic,

       char *reply

);
void psrp_int_sic
(
       FILE *stream,

       psrp_channel_type *sic

);
int psrp_set_client_exitf
(
       int chid,

       char *fname,

       int (*func)(int)

);
int psrp_reset_client_exitf(int chid);
int psrp_overlay_server_process
(
       FILE *stream,

       int over_fork,

       char *command_name,

       char *command_tail

);
int psrp_crontab_schedule
(
       FILE *stream,

       char *from,

       char *to,

       char *fname,

       void *func

);
int psrp_crontab_unschedule
(
       FILE *stream,

       int index

);
void psrp_crontab_init(void);

int psrp_show_crontab(FILE *stream);

PARAMETERS

int search (psrp_load_dispatch_table): If TRUE search for objects.
FILE *stream (psrp_load_dispatch_table): Error/log stream.
char *autoload_file_name: Dispatch table file name.
int bind_status: Not Documented.
int (*psrp_process_status)(int,char *argv[]): Not Documented.
long databag_size: Not Documented.
unsigned char *databag_handle: Not Documented.
int search (psrp_attach_dynamic_databag): If TRUE search DISPATCH_PATH directories.
FILE *stream (psrp_attach_dynamic_databag): Error/logging stream.
char *object_tag: Object (root) tag.
char *bag_file_name: Name of file containing bag data.
int h_mode (psrp_attach_dynamic_databag): Databag homeostasis mode.
int search (psrp_attach_shared_heap): If TRUE search DISPATCH_PATH directories for heap.
char *heap_tag: (Root) tag of shared heap.
char *heap_file_name: Name of file containing heap data.
int h_mode (psrp_attach_shared_heap): Heap homeostatsis mode.
void *object_handle: Not Documented.
int fd: Not Documented.
int index: Not Documented.
int event: Not Documented.
char *event_info: Not Documented.
char *name: Not Documented.
int argc: Not Documented.
char *argv[]: Not Documented.
int argd[]: Not Documented.
char *args[]: Not Documented.
char *error_string: Not Documented.
char *process_name: Not Documented.
int n_procs: Not Documented.
char *process_name[]: Not Documented.
int *n_pids: Not Documented.
int *pid_list: Not Documented.
char *pid_name[]: Not Documented.
int pid: Not Documented.
char *patchboard_path: Not Documented.
char *process_host: MAO.
char *host_name: Host to create client on.
char *psrp_pen: PEN of client.
char *channel_name: Channel to client.
char *request: Not Documented.
char *reply: Not Documented.
int *reply_length: Not Documented.
psrp_channel_type *channel: Not Documented.
FILE *psrp_out: Not Documented.
int *argc: Not Documented.
int *in_des: Not Documented.
int *out_des: Not Documented.
int *err_des: Not Documented.
FILE *in_stream: Not Documented.
FILE *out_stream: Not Documented.
FILE *err_stream: Not Documented.
int des: Not Documented.
char *alias: Not Documented.
char *base_tag_name: Not Documented.
char *basename: Not Documented.
int t_c_instance: Not Documented.
char *instance_name: Not Documented.
char *host: Not Documented.
int lock_channel: Not Documented.
char *server: Not Documented.
char host_list[][256]: Not Documented.
char *hostname: Not Documented.
char *password: Not Documented.
char *psrp_server: Not Documented.
int max_trys: Not Documented.
int *server_pid: Not Documented.
psrp_channel_type *sic: Not Documented.
int chid: Not Documented.
char *fname: Not Documented.
int over_fork: Not Documented.
char *command_name: Not Documented.
char *command_tail: Not Documented.
char *from: Not Documented.
char *to: Not Documented.
void *func: Not Documented.

DESCRIPTION

psrp_ignore_requests

Ignore PSRP requests (this routine also sets the appl_psrp flag to TRUE) ...

psrp_accept_requests

Accept PSRP requests ...

psrp_load_dispatch_table

Import PSRP dispatch table items ...

psrp_init

Initialise PSRP action handler system ...

psrp_load_default_dispatch_table

If an autoload file exists for this PSRP server load the objects in it and their (user defined attributes) ...

psrp_find_action_slot_index

Find action slot index by name ...

psrp_get_action_slot_index

Get the first free slot in the dispatch table allocating more space if necessary ...

psrp_attach_static_databag

Attach a static databag to the PSRP handler dispatch list ...

psrp_attach_dynamic_databag

Attach a dynamic databag to the PSRP handler dispatch list ...

psrp_attach_shared_heap

Attach a shared heap to the PSRP handler dispatch list ...

psrp_attach_static_function

Attach an action function to the PSRP handler dispatch list ...

psrp_show_object_list

Show function currently bound to PSRP action list ...

psrp_reset_dispatch_table

Routine to re-initialise the dispatch table -- all dynamic objects are detached and all static objects are restored to their initial states (e.g. Any aliases associated with static objects are removed) ...

psrp_detach_object_by_name

Routine to detach object from dispatch list by name ...

psrp_detach_object_by_handle

Routine to detach object from dispatch list by name ...

empty_fifo

Empty FIFO ...

psrp_chbrk_handler

Handler for unexpected PSRP channel timeouts ...

psrp_save_dispatch_table

Save dispatch table ...

psrp_exit

Remove communication channel when process exits ...

lookup_psrp_object_by_name

Get PSRP dispatch table entry by name ...

lookup_psrp_object_by_handle

Get PSRP dispatch table entry by handle ...

psrp_std_init

Standard initialisation function for builtins ...

psrp_t_arg_errs

PSRP argument decode checking function ...

psrp_ostate

Get state of the current object ...

psrp_destroy_object

Destroy psrp object (releasing its memory) ...

psrp_error

Send error message string to client ...

psrp_pname_to_pid

Do a name to pid conversion if user has given the name of the PSRP server process to be contacted ...

psrp_pnames_to_pidlist

Do a name to pid conversion if user has given the name of the PSRP server process to be contacted ...

psrp_pid_to_pname

Do a pid to name conversion if user has given the pid of the PSRP server process to be contacted ...

psrp_channelname_to_pid

Get pid from psrp channel name (given process name running on given host) ...

psrp_pid_to_channelname

Get psrp channel name from psrp channel name (given pid)_ ...

psrp_show_shared_heaps

Show shared heaps attached to this PSRP server ...

psrp_show_open_sics

Show PSRP slaved client channels open on this server ...

psrp_create_slaved_interaction_client

Send a single command to PSRP server process ...

psrp_slaved_client_transaction

Send a request to slaved psrp client and wait for reply ...

psrp_destroy_slaved_interaction_client

Routine to close a link to slaved PSRP interaction client - the client is terminated when the link count reaches zero ...

psrp_assign_stdio

Support routine for stream I/O required by PSRP task functions ...

psrp_assign_fstdio

Assign a set of input, output and error (log) streams ...

psrp_wait_for_data

Synchronous select routine - waits for data to become available on nominated descriptor ...

psrp_get_tag_index

Get index into the alias table of a PSRP object ...

psrp_ifree_tag_list

Free resources allocated to tag list ...

psrp_isearch_tag_list

Search tag list by index ...

psrp_alias

Create an alias for a PSRP object ...

psrp_unalias

Remove alias associated with a PSRP object ...

psrp_show_aliases

Routine to display tag names associated with a given PSRP object ...

psrp_new_instance

Routine to duplicate a PSRP process - this give the user their own private copy of the PSRP process which they can subsequently modify ...

psrp_channel_locked

Routine to check if a channel has a client locked on it ...

psrp_new_segment

Start the next segment of a multisegment server - If host is non null then start the new segment on that host and call it name ...

psrp_get_server_host

MAO Find host(s) on local cluster which are running specified server ...

psrp_prod_host

MAO Prod remote host (to see if it is alive) ...

psrp_authenticate

Authenticate user (prior to performing protected PSRP operation) ...

psrp_set_server_password

If server password is undefined, load definition from dynamic module ...

psrp_write_sic

Send request over slaved interaction clients channel ...

psrp_read_sic

Read reply over slaved interaction clients channel ...

psrp_int_sic

Send break to remote server ...

psrp_set_client_exitf

Install an exit function for a PSRP channel.

psrp_reset_client_exitf

Deinstall an exit function for a PSRP channel.

psrp_overlay_server_process

Overlay server process with specified command ...

psrp_crontab_schedule

Enter a scheduled activity into crontab table ...

psrp_crontab_unschedule

Unschedule a crontab slot ...

psrp_crontab_init

Initialise crontab ...

psrp_show_crontab

Display schedule of activities for this function ...

Index

psrp_ignore_requests
psrp_accept_requests
psrp_load_dispatch_table
psrp_init
psrp_load_default_dispatch_table
psrp_find_action_slot_index
psrp_get_action_slot_index
psrp_attach_static_databag
psrp_attach_dynamic_databag
psrp_attach_shared_heap
psrp_attach_static_function
psrp_show_object_list
psrp_reset_dispatch_table
psrp_detach_object_by_name
psrp_detach_object_by_handle
empty_fifo
psrp_chbrk_handler
psrp_save_dispatch_table
psrp_exit
lookup_psrp_object_by_name
lookup_psrp_object_by_handle
psrp_std_init
psrp_t_arg_errs
psrp_ostate
psrp_destroy_object
psrp_error
psrp_pname_to_pid
psrp_pnames_to_pidlist
psrp_pid_to_pname
psrp_channelname_to_pid
psrp_pid_to_channelname
psrp_show_shared_heaps
psrp_show_open_sics
psrp_create_slaved_interaction_client
psrp_slaved_client_transaction
psrp_destroy_slaved_interaction_client
psrp_assign_stdio
psrp_assign_fstdio
psrp_wait_for_data
psrp_get_tag_index
psrp_ifree_tag_list
psrp_isearch_tag_list
psrp_alias
psrp_unalias
psrp_show_aliases
psrp_new_instance
psrp_channel_locked
psrp_new_segment
psrp_get_server_host
psrp_prod_host
psrp_authenticate
psrp_set_server_password
psrp_write_sic
psrp_read_sic
psrp_int_sic
psrp_set_client_exitf
psrp_reset_client_exitf
psrp_overlay_server_process
psrp_crontab_schedule
psrp_crontab_unschedule
psrp_crontab_init
psrp_show_crontab

This document was created by man2html, using the manual pages.
Time: 16:36:10 GMT, January 10, 2008