trac/doxygen/service__internal_8h_source.html

 /*

  * Author : GÃ©rald FENOY

  *

  * Copyright (c) 2009-2013 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_H

 #define ZOO_SERVICE_INTERNAL_H 1


 #pragma once


 #define DEFAULT_SERVICE_URL "http://www.zoo-project.org/"


 #define TIME_SIZE 40


 #include <libintl.h>

 #include <locale.h>

 #define _(String) dgettext ("zoo-kernel",String)


 #define _ss(String) dgettext ("zoo-services",String)


 #define ZOO_LOCK_CREATE_FAILED -4


 #define ZOO_LOCK_ACQUIRE_FAILED -5


 #define ZOO_LOCK_RELEASE_FAILED -6


 #define ZOO_LOCK_MAX_RETRY 180


 #include <sys/stat.h>

 #include <sys/types.h>

 #ifndef WIN32

 #include <sys/ipc.h>

 #include <sys/shm.h>

 #include <sys/sem.h>

 #else

 #include <direct.h>

 #endif

 #include <stdio.h>

 #include <time.h>

 #include <ctype.h>

 #ifndef USE_RUBY

 #include <unistd.h>

 #endif

 #ifndef WIN32

 #include <locale.h>

 #endif


 #include <fcntl.h>


 #include "service.h"


 #if defined(macintosh) || (defined(__MACH__) && defined(__APPLE__))


 #include <CoreServices/CoreServices.h>

 #include <SystemConfiguration/SystemConfiguration.h>


 #endif


 #ifdef WIN32

 // fcntl flock definitions

 #define F_SETLK  8   // Non-Blocking set or clear a lock

 #define F_SETLKW 9   // Blocking set or clear a lock

 #define F_GETLK 10

 #define F_RDLCK  1   // read lock

 #define F_WRLCK  2   // write lock

 #define F_UNLCK  3   // remove lock

 struct flock {

     short l_type;   // F_RDLCK, F_WRLCK, or F_UNLCK

     short l_whence; // flag to choose starting offset, must be SEEK_SET

     long  l_start;  // relative offset, in bytes, must be 0

     long  l_len;    // length, in bytes; 0 means lock to EOF, must be 0

     short l_pid;    // unused (returned with the unsupported F_GETLK)

     short l_xxx;    // reserved for future use

 };

 #endif


 typedef struct zooLock{

   struct flock lock;

   FILE* lockfile;

   char* filename;

 } zooLock;


 static zooLock** zoo_file_locks=NULL;

 static int zoo_file_locks_cnt=0;


 #ifdef __cplusplus

 extern "C" {

 #endif


   ZOO_DLL_EXPORT char *readVSIFile(maps*,const char*);

   ZOO_DLL_EXPORT int  setOutputValue( maps*, const char*, char*, size_t);

   ZOO_DLL_EXPORT char* getInputValue( maps*,const char*,size_t*);


   ZOO_DLL_EXPORT struct zooLock* lockFile(maps*,const char*,const char);

   ZOO_DLL_EXPORT int unlockFile(maps*,struct zooLock*);


   ZOO_DLL_EXPORT void unhandleStatus(maps*);

   ZOO_DLL_EXPORT int _updateStatus(maps*);

   ZOO_DLL_EXPORT char* _getStatus(maps*,char*);

   ZOO_DLL_EXPORT char* _getStatusFile(maps*,char*);

   ZOO_DLL_EXPORT char* getStatus(int);

   ZOO_DLL_EXPORT char* getStatusId(maps*,char*);


   ZOO_DLL_EXPORT int updateStatus( maps*,const int,const char*);

   ZOO_DLL_EXPORT int removeShmLock(maps*, int);

 #ifndef WIN32

 #define semid int

 #else

 #include <windows.h>

 #define semid HANDLE

 #endif

   ZOO_DLL_EXPORT semid acquireLock(maps*);

   ZOO_DLL_EXPORT semid getShmLockId(maps*,int);

   ZOO_DLL_EXPORT int lockShm(semid);

   ZOO_DLL_EXPORT int unlockShm(semid);


   ZOO_DLL_EXPORT char* file_exists(const char* dir, const char* name);


 #ifdef __cplusplus

 }

 #endif


 #endif

zoo_file_locks
static zooLock ** zoo_file_locks
Definition: service_internal.h:125

zooLock::lock
struct flock lock
The lock.
Definition: service_internal.h:120

getStatus
ZOO_DLL_EXPORT char * getStatus(int)
Get the current status of the running service.
Definition: service_internal.c:807

zoo_file_locks_cnt
static int zoo_file_locks_cnt
Definition: service_internal.h:126

getShmLockId
ZOO_DLL_EXPORT semid getShmLockId(maps *, int)
Try to create or access a semaphore set.
Definition: service_internal.c:673

unlockShm
ZOO_DLL_EXPORT int unlockShm(semid)

_getStatus
ZOO_DLL_EXPORT char * _getStatus(maps *, char *)
Get the ongoing status of a running service.
Definition: service_internal.c:367

zooLock::lockfile
FILE * lockfile
The pointer to the lock file.
Definition: service_internal.h:121

acquireLock
ZOO_DLL_EXPORT semid acquireLock(maps *)
Acquire the global lock.
Definition: service_internal.c:261

lockShm
ZOO_DLL_EXPORT int lockShm(semid)

unlockFile
ZOO_DLL_EXPORT int unlockFile(maps *, struct zooLock *)
Remove a lock.
Definition: service_internal.c:198

ZOO_DLL_EXPORT
#define ZOO_DLL_EXPORT

lockFile
ZOO_DLL_EXPORT struct zooLock * lockFile(maps *, const char *, const char)
Lock a file for read, write and upload.
Definition: service_internal.c:96

unhandleStatus
ZOO_DLL_EXPORT void unhandleStatus(maps *)
Stop handling status repport.
Definition: service_internal.c:427

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

zooLock
The lock structure used by the ZOO-Kernel to ensure atomicity of operations.
Definition: service_internal.h:119

_updateStatus
ZOO_DLL_EXPORT int _updateStatus(maps *)
Update the current status of the running service.
Definition: service_internal.c:445

readVSIFile
ZOO_DLL_EXPORT char * readVSIFile(maps *, const char *)
Read a file using the GDAL VSI API.
Definition: service_internal.c:880

_getStatusFile
ZOO_DLL_EXPORT char * _getStatusFile(maps *, char *)
Read the cache file of a running service.
Definition: service_internal.c:300

getInputValue
ZOO_DLL_EXPORT char * getInputValue(maps *, const char *, size_t *)
Access an input value.
Definition: service_internal.c:858

file_exists
ZOO_DLL_EXPORT char * file_exists(const char *dir, const char *name)
Check if file exists in specified folder.
Definition: service_internal.c:937

setOutputValue
ZOO_DLL_EXPORT int setOutputValue(maps *, const char *, char *, size_t)
Set an output value.
Definition: service_internal.c:909

service.h

removeShmLock
ZOO_DLL_EXPORT int removeShmLock(maps *, int)
Try to remove a semaphore set.
Definition: service_internal.c:745

getStatusId
ZOO_DLL_EXPORT char * getStatusId(maps *, char *)
Read the sid file attached of a service if any.
Definition: service_internal.c:233

zooLock
struct zooLock zooLock
The lock structure used by the ZOO-Kernel to ensure atomicity of operations.

updateStatus
ZOO_DLL_EXPORT int updateStatus(maps *, const int, const char *)
Update the status of an ongoing service.
Definition: service_internal.c:841

semid
#define semid
Cross platform type used for Lock identifier.
Definition: service_internal.h:153

zooLock::filename
char * filename
The filename to lock.
Definition: service_internal.h:122