Changeset 581


Ignore:
Timestamp:
Feb 12, 2015, 11:44:48 PM (7 years ago)
Author:
djay
Message:

Continue adding initial doxygen comments.

Location:
trunk/zoo-project/zoo-kernel
Files:
4 edited

Legend:

Unmodified
Added
Removed
  • trunk/zoo-project/zoo-kernel/service_internal_js.c

    r580 r581  
    105105 * @param inputs the maps containing the inputs
    106106 * @param outputs the maps containing the outputs
    107  * @return ZOO_SERVICE_SUCCEEDED or ZOO_SERVICE_FAILED if the service run, -1
     107 * @return SERVICE_SUCCEEDED or SERVICE_FAILED if the service run, -1
    108108 *  if the service failed to load or throw error at runtime.
    109109 */
     
    959959 * @param argv1 the parameter values
    960960 * @return true
    961  * @see setHeader
     961 * @see setHeader,_updateStatus
    962962 */
    963963JSBool
  • trunk/zoo-project/zoo-kernel/service_internal_python.c

    r580 r581  
    613613 * @param self the Python object on which we can run the method
    614614 * @param args the Python arguments given from the Python environment
    615  * @return a new Python string containing the translated value to the Python
    616  *  environment
     615 * @return a new Python string containing the translated value
    617616 * @see _ss
    618617 */
  • trunk/zoo-project/zoo-kernel/service_internal_ruby.c

    r459 r581  
    1 /**
     1/*
    22 * Author : Gérald FENOY
    33 *
     
    3030#endif
    3131
     32/**
     33 * Load a Ruby file then run the function corresponding to the service by
     34 * passing the conf, inputs and outputs parameters by value as JavaScript
     35 * Objects.
     36 *
     37 * @param main_conf the conf maps containing the main.cfg settings
     38 * @param request the map containing the HTTP request
     39 * @param s the service structure
     40 * @param real_inputs the maps containing the inputs
     41 * @param real_outputs the maps containing the outputs
     42 * @return SERVICE_SUCCEEDED or SERVICE_FAILED if the service run, -1
     43 *  if the service failed to load or throw error at runtime.
     44 */
    3245int zoo_ruby_support(maps** main_conf,map* request,service* s,maps **real_inputs,maps **real_outputs){
    3346#if RUBY_API_VERSION_MAJOR >= 2 || RUBY_API_VERSION_MINOR == 9
     
    125138}
    126139
     140/**
     141 * Load a ruby file
     142 *
     143 * @arg the file to load
     144 * @return Qnil
     145 */
    127146VALUE LoadWrap(VALUE arg) {
    128147  const char *filename = reinterpret_cast<const char*>(arg);
     
    131150}
    132151
     152/**
     153 * Call a ruby function with parameters
     154 *
     155 * @arg the callback structure
     156 * @return the value returned the called ruby function
     157 */
    133158VALUE FunCallWrap(VALUE rdata) {
    134159  struct my_callback* data = (struct my_callback*) rdata;
     
    136161}
    137162
     163/**
     164 * Print the Ruby Stack Trace in an ows:ExceptionReport XML Document
     165 *
     166 * @param m the conf maps containing the main.cfg settings
     167 * @see printExceptionReportResponse
     168 */
    138169void ruby_trace_error(maps* m){
    139170#if RUBY_VERSION_MINOR == 8
     
    174205}
    175206
     207/**
     208 * Convert a maps to a Ruby Hash
     209 *
     210 * @param t the maps to convert
     211 * @return a new Ruby Hash
     212 */
    176213VALUE RubyHash_FromMaps(maps* t){
    177214  VALUE res=rb_hash_new();
     
    186223}
    187224
     225/**
     226 * Push the key on the array
     227 *
     228 * @param key the key to push
     229 * @param value not used
     230 * @param ary the Array
     231 * @return ST_CONTINUE
     232 */
    188233int
    189234keys_i(VALUE key,VALUE value,VALUE ary)
     
    194239}
    195240
     241/**
     242 * Return the size of a Ruby Hash
     243 *
     244 * @param hash the input Hash
     245 */
    196246VALUE
    197247rb_hash_size(VALUE hash)
     
    200250}
    201251
     252/**
     253 * Convert a map to a Ruby Hash
     254 *
     255 * @param t the map to convert
     256 * @return a new Ruby Hash
     257 */
    202258VALUE RubyHash_FromMap(map* t){
    203259  VALUE res=rb_hash_new( );
     
    277333}
    278334
    279 
     335/**
     336 * Convert a Ruby Hash to a maps
     337 *
     338 * @param t the Ruby Hash to convert
     339 * @return a new maps
     340 */
    280341maps* mapsFromRubyHash(VALUE t){
    281342  maps* res=NULL;
     
    309370}
    310371
     372/**
     373 * Convert a Ruby Hash to a map
     374 *
     375 * @param t the Ruby Hash to convert
     376 * @return a new map
     377 */
    311378map* mapFromRubyHash(VALUE t){
    312379  map* res=NULL;
     
    354421}
    355422
     423/**
     424 * Use the ZOO-Services messages translation function from the Ruby
     425 * environment (ZOO-API)
     426 *
     427 * @param argc the number of parameters
     428 * @param argv the parameter values given from the Ruby environment
     429 * @param obj the Ruby object on which we run the method
     430 * @return a new Ruby string containing the translated value
     431 * @see _ss
     432 */
    356433VALUE
    357434RubyTranslate(int argc, VALUE *argv, VALUE obj)
     
    360437}
    361438
     439/**
     440 * Update the ongoing status of a running service from the Ruby environment
     441 * (ZOO-API)
     442 *
     443 * @param argc the number of parameters
     444 * @param argv the parameter values given from the Ruby environment
     445 * @param obj the Ruby object on which we run the method
     446 * @return a new Ruby string containing the translated value
     447 * @see _updateStatus
     448 */
    362449VALUE
    363450RubyUpdateStatus(int argc, VALUE *argv, VALUE obj)
     
    392479    else
    393480      setMapInMaps(conf,"lenv","status","15");
    394     updateStatus(conf);
     481    _updateStatus(conf);
    395482  }
    396483  freeMaps(&conf);
  • trunk/zoo-project/zoo-kernel/service_internal_ruby.h

    r453 r581  
    1 /**
     1/*
    22 * Author : Gérald FENOY
    33 *
Note: See TracChangeset for help on using the changeset viewer.

Search

Context Navigation

ZOO Sponsors

http://www.zoo-project.org/trac/chrome/site/img/geolabs-logo.pnghttp://www.zoo-project.org/trac/chrome/site/img/neogeo-logo.png http://www.zoo-project.org/trac/chrome/site/img/apptech-logo.png http://www.zoo-project.org/trac/chrome/site/img/3liz-logo.png http://www.zoo-project.org/trac/chrome/site/img/gateway-logo.png

Become a sponsor !

Knowledge partners

http://www.zoo-project.org/trac/chrome/site/img/ocu-logo.png http://www.zoo-project.org/trac/chrome/site/img/gucas-logo.png http://www.zoo-project.org/trac/chrome/site/img/polimi-logo.png http://www.zoo-project.org/trac/chrome/site/img/fem-logo.png http://www.zoo-project.org/trac/chrome/site/img/supsi-logo.png http://www.zoo-project.org/trac/chrome/site/img/cumtb-logo.png

Become a knowledge partner

Related links

http://zoo-project.org/img/ogclogo.png http://zoo-project.org/img/osgeologo.png