trac/doxygen/service__internal__ruby_8h_source.html

 /*

  * Author : GÃ©rald FENOY

  *

  * Copyright (c) 2014 GeoLabs SARL

  *

  * Permission is hereby granted, free of charge, to any person obtaining a copy

  * of this software and associated documentation files (the "Software"), to deal

  * in the Software without restriction, including without limitation the rights

  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell

  * copies of the Software, and to permit persons to whom the Software is

  * furnished to do so, subject to the following conditions:

  *

  * The above copyright notice and this permission notice shall be included in

  * all copies or substantial portions of the Software.

  *

  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER

  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,

  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN

  * THE SOFTWARE.

  */


 #ifndef ZOO_SERVICE_INTERNAL_RUBY_H

 #define ZOO_SERVICE_INTERNAL_RUBY_H 1


 #pragma once


 #define RUBY_GLOBAL_SETUP

 #undef NEED_STRLCAT

 #undef NEED_STRLCPY

 #include "service.h"

 #include "service_internal.h"

 #undef RUBY_EXPORT

 #undef STRCASECMP

 #undef STRNCASECMP

 #undef _

 #include <ruby.h>

 #if ZRUBY_VERSION < 2

 #include <version.h>

 #else

 #include <ruby/version.h>

 #endif

 #if RUBY_VERSION_MINOR==8

 #include <st.h>

 #else

 #include <ruby/st.h>

 #endif


 #define MAX_ARGS 3


 struct my_callback {

   VALUE obj;

   ID method_id;

   int nargs;

   VALUE args[MAX_ARGS];

 };


 void ruby_trace_error(maps*);

 VALUE FunCallWrap(VALUE);

 VALUE LoadWrap(VALUE);


 VALUE RubyHash_FromMaps(maps*);

 VALUE RubyHash_FromMap(map*);


 maps* mapsFromRubyHash(VALUE);

 void createMapsFromRubyHash(maps**,VALUE);

 map* mapFromRubyHash(VALUE);


 int zoo_ruby_support(maps**,map*,service*,maps**,maps**);


 VALUE RubyTranslate(int,VALUE*,VALUE);

 VALUE RubyUpdateStatus(int,VALUE*,VALUE);


 #endif

RubyTranslate
VALUE RubyTranslate(int, VALUE *, VALUE)
Use the ZOO-Services messages translation function from the Ruby environment (ZOO-API) ...
Definition: service_internal_ruby.c:445

my_callback::args
VALUE args[MAX_ARGS]
The arguments values.
Definition: service_internal_ruby.h:59

LoadWrap
VALUE LoadWrap(VALUE)
Load a ruby file.
Definition: service_internal_ruby.c:145

my_callback::obj
VALUE obj
Object used to call a method.
Definition: service_internal_ruby.h:56

RubyHash_FromMaps
VALUE RubyHash_FromMaps(maps *)
Convert a maps to a Ruby Hash.
Definition: service_internal_ruby.c:212

RubyUpdateStatus
VALUE RubyUpdateStatus(int, VALUE *, VALUE)
Update the ongoing status of a running service from the Ruby environment (ZOO-API) ...
Definition: service_internal_ruby.c:461

mapsFromRubyHash
maps * mapsFromRubyHash(VALUE)
Convert a Ruby Hash to a maps.
Definition: service_internal_ruby.c:355

maps
linked list of map pointer
Definition: main_conf_read.y:292

createMapsFromRubyHash
void createMapsFromRubyHash(maps **, VALUE)

RubyHash_FromMap
VALUE RubyHash_FromMap(map *)
Convert a map to a Ruby Hash.
Definition: service_internal_ruby.c:257

map
KVP linked list.
Definition: service.h:244

FunCallWrap
VALUE FunCallWrap(VALUE)
Call a ruby function with parameters.
Definition: service_internal_ruby.c:157

service
Metadata information about a full Service.
Definition: main_conf_read.y:329

MAX_ARGS
#define MAX_ARGS
Definition: service_internal_ruby.h:51

service_internal.h

service.h

zoo_ruby_support
int zoo_ruby_support(maps **, map *, service *, maps **, maps **)
Load a Ruby file then run the function corresponding to the service by passing the conf...
Definition: service_internal_ruby.c:44

mapFromRubyHash
map * mapFromRubyHash(VALUE)
Convert a Ruby Hash to a map.
Definition: service_internal_ruby.c:389

ruby_trace_error
void ruby_trace_error(maps *)
Print the Ruby Stack Trace in an ows:ExceptionReport XML Document.
Definition: service_internal_ruby.c:168

my_callback::nargs
int nargs
The arguments number.
Definition: service_internal_ruby.h:58

my_callback::method_id
ID method_id
The method to call.
Definition: service_internal_ruby.h:57

my_callback
The Ruby method pointer.
Definition: service_internal_ruby.h:55