service_internal_ruby.h File Reference

#include "service.h"
#include "service_internal.h"
#include <ruby.h>
#include <version.h>
#include <ruby/st.h>

Go to the source code of this file.

Data Structures
struct	my_callback
	The Ruby method pointer. More...

Macros
#define	RUBY_GLOBAL_SETUP
#define	MAX_ARGS   3

Functions
void	ruby_trace_error (maps *)
	Print the Ruby Stack Trace in an ows:ExceptionReport XML Document. More...
VALUE	FunCallWrap (VALUE)
	Call a ruby function with parameters. More...
VALUE	LoadWrap (VALUE)
	Load a ruby file. More...
VALUE	RubyHash_FromMaps (maps *)
	Convert a maps to a Ruby Hash. More...
VALUE	RubyHash_FromMap (map *)
	Convert a map to a Ruby Hash. More...
maps *	mapsFromRubyHash (VALUE)
	Convert a Ruby Hash to a maps. More...
void	createMapsFromRubyHash (maps **, VALUE)
map *	mapFromRubyHash (VALUE)
	Convert a Ruby Hash to a map. More...
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, inputs and outputs parameters by refernce as Ruby Hash. More...
VALUE	RubyTranslate (int, VALUE *, VALUE)
	Use the ZOO-Services messages translation function from the Ruby environment (ZOO-API) More...
VALUE	RubyUpdateStatus (int, VALUE *, VALUE)
	Update the ongoing status of a running service from the Ruby environment (ZOO-API) More...

---

Data Structure Documentation

my_callback

struct my_callback

The Ruby method pointer.

Data Fields
VALUE	args[MAX_ARGS]	The arguments values.
ID	method_id	The method to call.
int	nargs	The arguments number.
VALUE	obj	Object used to call a method.

Macro Definition Documentation

MAX_ARGS

#define MAX_ARGS   3

RUBY_GLOBAL_SETUP

#define RUBY_GLOBAL_SETUP

Function Documentation

createMapsFromRubyHash()

void createMapsFromRubyHash	(	maps **	,
		VALUE
	)

FunCallWrap()

VALUE FunCallWrap

(

VALUE

rdata

)

Call a ruby function with parameters.

• the callback structure

  Returns

  the value returned the called ruby function

LoadWrap()

VALUE LoadWrap

(

VALUE

arg

)

Load a ruby file.

• the file to load

  Returns

  Qnil

mapFromRubyHash()

map* mapFromRubyHash

(

VALUE

t

)

Convert a Ruby Hash to a map.

Parameters

t	the Ruby Hash to convert

Returns

a new map

mapsFromRubyHash()

maps* mapsFromRubyHash

(

VALUE

t

)

Convert a Ruby Hash to a maps.

Parameters

t	the Ruby Hash to convert

Returns

a new maps

ruby_trace_error()

void ruby_trace_error

(

maps *

m

)

Print the Ruby Stack Trace in an ows:ExceptionReport XML Document.

Parameters

m	the conf maps containing the main.cfg settings

See also

printExceptionReportResponse

RubyHash_FromMap()

VALUE RubyHash_FromMap

(

map *

t

)

Convert a map to a Ruby Hash.

Parameters

t	the map to convert

Returns

a new Ruby Hash

RubyHash_FromMaps()

VALUE RubyHash_FromMaps

(

maps *

t

)

Convert a maps to a Ruby Hash.

Parameters

t	the maps to convert

Returns

a new Ruby Hash

RubyTranslate()

VALUE RubyTranslate	(	int	argc,
		VALUE *	argv,
		VALUE	obj
	)

Use the ZOO-Services messages translation function from the Ruby environment (ZOO-API)

Parameters

argc	the number of parameters
argv	the parameter values given from the Ruby environment
obj	the Ruby object on which we run the method

Returns

a new Ruby string containing the translated value

See also

_ss

RubyUpdateStatus()

VALUE RubyUpdateStatus	(	int	argc,
		VALUE *	argv,
		VALUE	obj
	)

Update the ongoing status of a running service from the Ruby environment (ZOO-API)

Parameters

argc	the number of parameters
argv	the parameter values given from the Ruby environment
obj	the Ruby object on which we run the method

Returns

a new Ruby string containing the translated value

See also

_updateStatus

zoo_ruby_support()

int zoo_ruby_support	(	maps **	main_conf,
		map *	request,
		service *	s,
		maps **	real_inputs,
		maps **	real_outputs
	)

Load a Ruby file then run the function corresponding to the service by passing the conf, inputs and outputs parameters by refernce as Ruby Hash.

Parameters

main_conf	the conf maps containing the main.cfg settings
request	the map containing the HTTP request
s	the service structure
real_inputs	the maps containing the inputs
real_outputs	the maps containing the outputs

Returns

SERVICE_SUCCEEDED or SERVICE_FAILED if the service run, -1 if the service failed to load or throw error at runtime.