From 1d9e5373fa78de0e9e97eb57d707af4f17647dc4 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Jan=20Posp=C3=AD=C5=A1il?= Date: Fri, 18 Feb 2005 12:57:31 +0000 Subject: [PATCH] Documentation update --- org.glite.lb.client-interface/Makefile | 3 +- org.glite.lb.client-interface/interface/CountRef.h | 11 +++- org.glite.lb.client-interface/interface/Event.h.T | 4 +- org.glite.lb.client-interface/interface/Job.h | 70 ++++++++++++++++++---- .../interface/LoggingExceptions.h | 4 +- .../interface/Notification.h | 4 +- .../interface/ServerConnection.h | 4 +- org.glite.lb.client-interface/interface/consumer.h | 15 ++++- org.glite.lb.client-interface/interface/context.h | 38 ++++++++---- org.glite.lb.client-interface/interface/events.h.T | 5 +- .../interface/notification.h | 2 +- .../interface/producer.h.T | 1 - .../project/version.properties | 2 +- 13 files changed, 124 insertions(+), 39 deletions(-) diff --git a/org.glite.lb.client-interface/Makefile b/org.glite.lb.client-interface/Makefile index 39d467d..f4fc58a 100644 --- a/org.glite.lb.client-interface/Makefile +++ b/org.glite.lb.client-interface/Makefile @@ -58,12 +58,13 @@ doc: generate doxygen C.dox doxygen CPP.dox -install: +install: generate doc -mkdir -p ${PREFIX}/${STAGETO} -mkdir -p ${PREFIX}/share/doc/${package}-${version} install -m 644 ${GEN_H} ${PREFIX}/${STAGETO} install -m 644 ${top_srcdir}/LICENSE ${PREFIX}/share/doc/${package}-${version} cd ${top_srcdir}/interface && install -m 644 ${STATIC_H} ${PREFIX}/${STAGETO} + cd ${top_srcdir}/doc && cp -r C CPP ${PREFIX}/share/doc/${package}-${version} clean: rm -f *.h diff --git a/org.glite.lb.client-interface/interface/CountRef.h b/org.glite.lb.client-interface/interface/CountRef.h index a8f61cf..462800d 100644 --- a/org.glite.lb.client-interface/interface/CountRef.h +++ b/org.glite.lb.client-interface/interface/CountRef.h @@ -1,10 +1,17 @@ #ifndef __EDG_WORKLOAD_LOGGING_CLIENT_COUNTREF_HPP__ #define __EDG_WORKLOAD_LOGGING_CLIENT_COUNTREF_HPP__ +/** + * Switching into glite.lb namespace (couple with EWL_END_NAMESPACE). + */ #define EWL_BEGIN_NAMESPACE namespace glite { namespace lb { + +/** + * Leave the glite.lb namespace. + */ #define EWL_END_NAMESPACE } } -EWL_BEGIN_NAMESPACE; +EWL_BEGIN_NAMESPACE template class CountRef { @@ -43,6 +50,6 @@ void CountRef::use(void) count++; } -EWL_END_NAMESPACE; +EWL_END_NAMESPACE #endif diff --git a/org.glite.lb.client-interface/interface/Event.h.T b/org.glite.lb.client-interface/interface/Event.h.T index 64b4958..29834d3 100644 --- a/org.glite.lb.client-interface/interface/Event.h.T +++ b/org.glite.lb.client-interface/interface/Event.h.T @@ -23,7 +23,7 @@ #include "glite/lb/events.h" #include "glite/lb/notifid.h" -EWL_BEGIN_NAMESPACE; +EWL_BEGIN_NAMESPACE class Event { friend class Job; @@ -143,6 +143,6 @@ private: CountRef *flesh; }; -EWL_END_NAMESPACE; +EWL_END_NAMESPACE #endif diff --git a/org.glite.lb.client-interface/interface/Job.h b/org.glite.lb.client-interface/interface/Job.h index 8f69ed8..58a8e91 100644 --- a/org.glite.lb.client-interface/interface/Job.h +++ b/org.glite.lb.client-interface/interface/Job.h @@ -15,12 +15,13 @@ * @version $Revision$ */ -EWL_BEGIN_NAMESPACE; +EWL_BEGIN_NAMESPACE /** L&B job. + * * Implementation of L&B job-specific calls. * Connection to the server is maintained transparently. -*/ + */ class Job { public: @@ -50,25 +51,72 @@ public: const std::vector log(void) const; /** Return last known address of a listener associated to the job. - * \param name name of the listener + * \param name IN name of the listener * \return hostname and port number */ const std::pair queryListener(const std::string & name) const; - /** Manipulate LB parameters, the same as for edg_wll_Context in C */ - void setParam(edg_wll_ContextParam, int); - void setParam(edg_wll_ContextParam, const std::string); - void setParam(edg_wll_ContextParam, const struct timeval &); + /** + * Manipulate LB parameters. + * + * The same as for edg_wll_Context in C + * + * \param ctx INOUT context to work with + * \param val IN value + */ + void setParam(edg_wll_ContextParam ctx, int val); + /** + * Manipulate LB parameters. + * + * The same as for edg_wll_Context in C + * + * \param ctx INOUT context to work with + * \param val IN value + */ + void setParam(edg_wll_ContextParam ctx, const std::string val); + /** + * Manipulate LB parameters. + * + * The same as for edg_wll_Context in C + * + * \param ctx INOUT context to work with + * \param val IN value + */ + void setParam(edg_wll_ContextParam ctx, const struct timeval &val); - int getParamInt(edg_wll_ContextParam) const; - std::string getParamString(edg_wll_ContextParam) const; - struct timeval getParamTime(edg_wll_ContextParam) const; + /** + * Get LB parameters. + * + * The same as for edg_wll_Context in C + * + * \param ctx INOUT context to work with + * \return integer value of the parameter + */ + int getParamInt(edg_wll_ContextParam ctx) const; + /** + * Get LB parameters. + * + * The same as for edg_wll_Context in C + * + * \param ctx INOUT context to work with + * \return string value of the parameter + */ + std::string getParamString(edg_wll_ContextParam ctx) const; + /** + * Get LB parameters. + * + * The same as for edg_wll_Context in C + * + * \param ctx INOUT context to work with + * \return timeval value of the parameter + */ + struct timeval getParamTime(edg_wll_ContextParam ctx) const; private: ServerConnection server; glite::wmsutils::jobid::JobId jobId; }; -EWL_END_NAMESPACE; +EWL_END_NAMESPACE #endif diff --git a/org.glite.lb.client-interface/interface/LoggingExceptions.h b/org.glite.lb.client-interface/interface/LoggingExceptions.h index 1d22a2e..15ce0ab 100644 --- a/org.glite.lb.client-interface/interface/LoggingExceptions.h +++ b/org.glite.lb.client-interface/interface/LoggingExceptions.h @@ -11,7 +11,7 @@ #include -EWL_BEGIN_NAMESPACE; +EWL_BEGIN_NAMESPACE class Exception: public glite::wmsutils::exception::Exception { public: @@ -139,6 +139,6 @@ public: -EWL_END_NAMESPACE; +EWL_END_NAMESPACE #endif diff --git a/org.glite.lb.client-interface/interface/Notification.h b/org.glite.lb.client-interface/interface/Notification.h index 4ce8fe4..bc9bf88 100644 --- a/org.glite.lb.client-interface/interface/Notification.h +++ b/org.glite.lb.client-interface/interface/Notification.h @@ -9,7 +9,7 @@ #include "glite/lb/JobStatus.h" -EWL_BEGIN_NAMESPACE; +EWL_BEGIN_NAMESPACE /** Manage LB notifications. @@ -91,6 +91,6 @@ private: }; -EWL_END_NAMESPACE; +EWL_END_NAMESPACE #endif diff --git a/org.glite.lb.client-interface/interface/ServerConnection.h b/org.glite.lb.client-interface/interface/ServerConnection.h index 05e277d..58a5fc9 100644 --- a/org.glite.lb.client-interface/interface/ServerConnection.h +++ b/org.glite.lb.client-interface/interface/ServerConnection.h @@ -17,7 +17,7 @@ #include "glite/lb/JobStatus.h" #include "glite/lb/consumer.h" -EWL_BEGIN_NAMESPACE; +EWL_BEGIN_NAMESPACE /** Auxiliary class to hold an atomic query condition. */ class QueryRecord { @@ -293,6 +293,6 @@ private: edg_wll_Context context; }; -EWL_END_NAMESPACE; +EWL_END_NAMESPACE #endif diff --git a/org.glite.lb.client-interface/interface/consumer.h b/org.glite.lb.client-interface/interface/consumer.h index 1284b90..d34c6de 100644 --- a/org.glite.lb.client-interface/interface/consumer.h +++ b/org.glite.lb.client-interface/interface/consumer.h @@ -126,7 +126,7 @@ extern int set_server_name_and_port( /** * General query on events. - * Return events satysfying all conditions + * Return events satisfying all conditions * query records represent conditions in the form * \a attr \a op \a value eg. time > 87654321. * \see edg_wll_QueryRec @@ -243,10 +243,15 @@ int edg_wll_JobStatus( /** * Query LBProxy and use plain communication + * \param context IN: context to operate on + * \param jobid IN: query this job + * \param flags IN: specifies optional status fields to retrieve, + * \see EDG_WLL_STAT_CLASSADS, EDG_WLL_STAT_CHILDREN, EDG_WLL_STAT_CHILDSTAT + * \param status OUT: the status of the job */ int edg_wll_JobStatusProxy( edg_wll_Context context, - const edg_wlc_JobId jobid, + const edg_wlc_JobId jobid, int flags, edg_wll_JobStat *status ); @@ -376,9 +381,13 @@ void edg_wll_QueryRecFree(edg_wll_QueryRec *); /** - * default and maximal query timeout (in seconds) + * default query timeout (in seconds) */ #define EDG_WLL_QUERY_TIMEOUT_DEFAULT 120 + +/** + * maximal query timeout (in seconds) + */ #define EDG_WLL_QUERY_TIMEOUT_MAX 1800 #ifdef __cplusplus diff --git a/org.glite.lb.client-interface/interface/context.h b/org.glite.lb.client-interface/interface/context.h index f811fc2..a4b7c3a 100644 --- a/org.glite.lb.client-interface/interface/context.h +++ b/org.glite.lb.client-interface/interface/context.h @@ -101,16 +101,34 @@ int edg_wll_SetParam( ... ); -struct timeval; /* gcc, shut up! */ - -/** Set an int context parameter */ -int edg_wll_SetParamInt(edg_wll_Context,edg_wll_ContextParam,int); - -/** Set a string context parameter */ -int edg_wll_SetParamString(edg_wll_Context,edg_wll_ContextParam,const char *); - -/** Set a timeval context parameter */ -int edg_wll_SetParamTime(edg_wll_Context,edg_wll_ContextParam,const struct timeval *); +struct timeval; /* XXX: gcc, shut up! */ + +/** Set a context parameter of type int. + * \param ctx INOUT context to work with + * \param param IN parameter to set + * \param val IN value to set + * \retval 0 success + * \retval EINVAL param is not a valid parameter, or invalid value + */ +int edg_wll_SetParamInt(edg_wll_Context ctx,edg_wll_ContextParam param,int val); + +/** Set a context parameter of type string. + * \param ctx INOUT context to work with + * \param param IN parameter to set + * \param val In value to set (if NULL, default is used) + * \retval 0 success + * \retval EINVAL param is not a valid parameter, or invalid value + */ +int edg_wll_SetParamString(edg_wll_Context ctx,edg_wll_ContextParam param,const char *val); + +/** Set a context parameter of type timeval. + * \param ctx INOUT context to work with + * \param param IN parameter to set + * \param val IN value to set (if NULL, default is used) + * \retval 0 success + * \retval EINVAL param is not a valid parameter, or invalid value + */ +int edg_wll_SetParamTime(edg_wll_Context ctx,edg_wll_ContextParam param,const struct timeval *val); /** Get current parameter value. * \param context INOUT context to work with diff --git a/org.glite.lb.client-interface/interface/events.h.T b/org.glite.lb.client-interface/interface/events.h.T index e4d0f89..e9be675 100644 --- a/org.glite.lb.client-interface/interface/events.h.T +++ b/org.glite.lb.client-interface/interface/events.h.T @@ -2,7 +2,6 @@ #define __EDG_WORKLOAD_LOGGING_CLIENT_EVENTS_H__ /** - * \file events.h * \brief contains definition of event type codes for use both by lbapi.h and dglog.h */ @@ -243,6 +242,10 @@ for ($event->getFieldsOrdered) { gen "\n"; @@@} +/** + * \typedef edg_wll_AnyEvent + * common structure definition contained in all types of the events + */ typedef struct _edg_wll_AnyEvent { _EDG_WLL_EVENT_COMMON } edg_wll_AnyEvent; diff --git a/org.glite.lb.client-interface/interface/notification.h b/org.glite.lb.client-interface/interface/notification.h index a16215d..5c87c0f 100644 --- a/org.glite.lb.client-interface/interface/notification.h +++ b/org.glite.lb.client-interface/interface/notification.h @@ -129,7 +129,7 @@ int edg_wll_NotifReceive( /** Default socket descriptor where to select(2) for notifications. - * Even if nothing is available for reading freom the socket, + * Even if nothing is available for reading from the socket, * there may be some data cached so calling \see edg_wll_NotifReceive * may return notifications immediately. * diff --git a/org.glite.lb.client-interface/interface/producer.h.T b/org.glite.lb.client-interface/interface/producer.h.T index f01a567..051eb08 100644 --- a/org.glite.lb.client-interface/interface/producer.h.T +++ b/org.glite.lb.client-interface/interface/producer.h.T @@ -354,7 +354,6 @@ extern int edg_wll_RegisterJobSync( * \param context INOUT context to work with * \param job IN jobId * \param type IN EDG_WLL_JOB_SIMPLE, EDG_WLL_JOB_DAG, or EDG_WLL_JOB_PARTITIONABLE - * \param user IN user credentials * \param jdl IN user-specified JDL * \param ns IN network server contact * \param num_subjobs IN number of subjobs to create diff --git a/org.glite.lb.client-interface/project/version.properties b/org.glite.lb.client-interface/project/version.properties index 615fa20..2ad7f30 100644 --- a/org.glite.lb.client-interface/project/version.properties +++ b/org.glite.lb.client-interface/project/version.properties @@ -1,4 +1,4 @@ #Wed Jan 12 04:06:13 CET 2005 -module.version=1.2.0 +module.version=1.2.1 module.build=146 module.age=1 -- 1.8.2.3