Section 3: library functions
poll_joystick – Polls the joystick. Allegro game programming library. Synopsis #include <allegro.h> int poll_joystick(); Description The joystick handler is not interrupt driven, so you need to call this function every now and again to update the global position values. Example: do { /* Get joystick input */ poll_joystick(); /* Process input for the first joystick…
PMIx_Put – Push a value into the client’s namespace Synopsis #include <pmix.h> pmix_status_t PMIx_Init(pmix_scope_t scope, const char key[], pmix_value_t *val); Arguments scope : Defines a scope for data "put" by PMI per the following: * PMI_LOCAL – the data is intended only for other application processes on the same node. Data marked in this way will…
PMIx_Initialized – Check if PMIxInit_ has been called Synopsis #include <pmix.h> int PMIx_Initialized(void); Arguments none Description Check to see if the PMIx Client library has been intialized Return Value Returns true if the PMIx Client has been initialized, and false if not. Errors Notes See Also PMIx_Init(3) Authors PMIx.
PMIx_Init – Initialize the PMIx Client Synopsis #include <pmix.h> pmix_status_t PMIx_Init(pmix_proc_t *proc); Arguments proc : Pointer to a pmix_proc_t object in which the client’s namespace and rank are to be returned. Description Initialize the PMIx client, returning the process identifier assigned to this client’s application in the provided pmix_proc_t struct. Passing a parameter of NULL…
PMIx_Finalize – Finalize the PMIx Client Synopsis #include <pmix.h> pmix_status_t PMIx_Finalize(void); Arguments Description Finalize the PMIx client, closing the connection with the local PMIx server. Return Value Returns PMIX_SUCCESS on success. On error, a negative value corresponding to a PMIx errno is returned. Errors PMIx errno values are defined in pmix_common.h. Notes See Also PMIx_Init(3)…
PMIx_Commit – Push all previously PMIxPut_ values to the local PMIx server. Synopsis #include <pmix.h> pmix_status_t PMIx_Commit(void); Arguments none Description This is an asynchronous operation – the library will immediately return to the caller while the data is transmitted to the local server in the background Return Value Returns PMIX_SUCCESS on success. On error, a…
PMIx_Abort – Abort the specified processes Synopsis #include <pmix.h> pmix_status_t PMIx_Abort(int status, const char msg[], pmix_proc_t procs[], size_t nprocs); Arguments status : Status value to be returned. A value of zero is permitted by PMIx, but may not be returned by some resource managers. msg : A string message to be displayed procs : An…
pmiWrite – flush data to a LOGIMPORT archive C Synopsis #include <pcp/pmapi.h> #include <pcp/impl.h> #include <pcp/import.h> int pmiWrite(int sec, int usec); cc … -lpcp_import -lpcp Perl SYNOPSIS use PCP::LogImport; pmiWrite($sec, $usec); Description As part of the Performance Co-Pilot Log Import API (see LOGIMPORT(3)), pmiWrite forces accumulated data values out to the PCP archive. The data…
pmiUseContext – change LOGIMPORT context C Synopsis #include <pcp/pmapi.h> #include <pcp/impl.h> #include <pcp/import.h> int pmiUseContext(int context); cc … -lpcp_import -lpcp Perl SYNOPSIS use PCP::LogImport; pmiUseContext($context); Description As part of the Performance Co-Pilot Log Import API (see LOGIMPORT(3)), pmiUseContext may be used by applications wishing to generate more than one PCP archive concurrently. The context argument…
pmiStart – establish a new LOGIMPORT context C Synopsis #include <pcp/pmapi.h> #include <pcp/impl.h> #include <pcp/import.h> int pmiStart(const char *archive, int inherit); cc … -lpcp_import -lpcp Perl SYNOPSIS use PCP::LogImport; pmiStart($archive, $inherit); Description As part of the Performance Co-Pilot Log Import API (see LOGIMPORT(3)), pmiStart creates a new context. Each context maintains the following state and…
pmiSetTimezone – set the source timezone for a LOGIMPORT archive C Synopsis #include <pcp/pmapi.h> #include <pcp/impl.h> #include <pcp/import.h> int pmiSetTimezone(const char *value); cc … -lpcp_import -lpcp Perl SYNOPSIS use PCP::LogImport; pmiSetTimezone($value); Description As part of the Performance Co-Pilot Log Import API (see LOGIMPORT(3)), pmiSetTimezone sets the source timezone in the current context to be value….
pmiSetHostname – set the source host name for a LOGIMPORT archive C Synopsis #include <pcp/pmapi.h> #include <pcp/impl.h> #include <pcp/import.h> int pmiSetHostname(const char *value); cc … -lpcp_import -lpcp Perl SYNOPSIS use PCP::LogImport; pmiSetHostname($value); Description As part of the Performance Co-Pilot Log Import API (see LOGIMPORT(3)), pmiSetHostname sets the source hostname in the current context to be…
pmiPutValueHandle – add a value for a metric-instance pair via a handle C Synopsis #include <pcp/pmapi.h> #include <pcp/impl.h> #include <pcp/import.h> int pmiPutValueHandle(int handle, const char *value); cc … -lpcp_import -lpcp Perl SYNOPSIS use PCP::LogImport; pmiPutValueHandle($handle, $value); Description As part of the Performance Co-Pilot Log Import API (see LOGIMPORT(3)), pmiPutValueHandle adds a single value to the…
pmiPutValue – add a value for a metric-instance pair C Synopsis #include <pcp/pmapi.h> #include <pcp/impl.h> #include <pcp/import.h> int pmiPutValue(const char *name, const char *instance, const char *value); cc … -lpcp_import -lpcp Perl SYNOPSIS use PCP::LogImport; pmiPutValue($name, $instance, $value); Description As part of the Performance Co-Pilot Log Import API (see LOGIMPORT(3)), pmiPutValue adds a single value to…
pmiPutResult – add a data record to a LOGIMPORT archive C Synopsis #include <pcp/pmapi.h> #include <pcp/impl.h> #include <pcp/import.h> int pmiPutResult(const pmResult *result); cc … -lpcp_import -lpcp Description As part of the Performance Co-Pilot Log Import API (see LOGIMPORT(3)), pmiPutResult provides an interface for developers familiar with the internal PCP data structures to create output archives…
pmiPutMark – write a <mark> record to a PCP archive C Synopsis #include <pcp/pmapi.h> #include <pcp/impl.h> #include <pcp/import.h> int pmiPutMark(void); cc … -lpcp_import -lpcp Perl SYNOPSIS use PCP::LogImport; pmiPutMark(); Description As part of the Performance Co-Pilot Log Import API (see LOGIMPORT(3)), pmiPutMark writes a <mark> record to the current PCP output archive. This is required…
pmiUnits, pmiID, pmiInDom – construct core metric data structures C Synopsis #include <pcp/pmapi.h> #include <pcp/import.h> pmID pmiID(int domain, int cluster, int item); pmInDom pmiInDom(int domain, int serial); pmUnits pmiUnits(int dimSpace, int dimTime, int dimCount, int scaleSpace, int scaleTime, int scaleCount); cc … -lpcp_import -lpcp Perl SYNOPSIS use PCP::LogImport; $pmid = pmiID($domain, $cluster, $item); $indom = pmiInDom($domain, $serial); $units…
pmiGetHandle – define a handle for a metric-instance pair C Synopsis #include <pcp/pmapi.h> #include <pcp/impl.h> #include <pcp/import.h> int pmiGetHandle(const char *name, const char *instance); cc … -lpcp_import -lpcp Perl SYNOPSIS use PCP::LogImport; $handle = pmiGetHandle($name, $instance); Description As part of the Performance Co-Pilot Log Import API (see LOGIMPORT(3)), pmiGetHandle creates a handle for a given…
pmiErrStr – convert a LOGIMPORT error code into a string C Synopsis #include <pcp/pmapi.h> #include <pcp/import.h> const char *pmiErrStr(int code); char *pmiErrStr_r(int code, char buf, int buflen); cc … -lpcp_import -lpcp Perl SYNOPSIS use PCP::LogImport; pmiErrStr($code); Description As part of the Performance Co-Pilot Log Import API (see LOGIMPORT(3)), pmiErrStr translates error codes returned from the…
pmiEnd – finish up a LOGIMPORT archive C Synopsis #include <pcp/pmapi.h> #include <pcp/impl.h> #include <pcp/import.h> int pmiEnd(void); cc … -lpcp_import -lpcp Perl SYNOPSIS use PCP::LogImport; pmiEnd(); Description As part of the Performance Co-Pilot Log Import API (see LOGIMPORT(3)), pmiEnd closes the current context, forcing the trailer records to be written to the PCP archive files,…