Mercurial > hg > orthanc
annotate Plugins/OrthancCPlugin/OrthancCPlugin.h @ 897:bafc9d592632 plugins
REST callbacks are working
author | Sebastien Jodogne <s.jodogne@gmail.com> |
---|---|
date | Tue, 17 Jun 2014 17:43:39 +0200 |
parents | c4053ac5db04 |
children | 7000fc86fe62 |
rev | line source |
---|---|
886 | 1 /** |
2 * Orthanc - A Lightweight, RESTful DICOM Store | |
3 * Copyright (C) 2012-2014 Medical Physics Department, CHU of Liege, | |
4 * Belgium | |
5 * | |
6 * This program is free software: you can redistribute it and/or | |
7 * modify it under the terms of the GNU General Public License as | |
8 * published by the Free Software Foundation, either version 3 of the | |
9 * License, or (at your option) any later version. | |
10 * | |
11 * In addition, as a special exception, the copyright holders of this | |
12 * program give permission to link the code of its release with the | |
13 * OpenSSL project's "OpenSSL" library (or with modified versions of it | |
14 * that use the same license as the "OpenSSL" library), and distribute | |
15 * the linked executables. You must obey the GNU General Public License | |
16 * in all respects for all of the code used other than "OpenSSL". If you | |
17 * modify file(s) with this exception, you may extend this exception to | |
18 * your version of the file(s), but you are not obligated to do so. If | |
19 * you do not wish to do so, delete this exception statement from your | |
20 * version. If you delete this exception statement from all source files | |
21 * in the program, then also delete it here. | |
22 * | |
23 * This program is distributed in the hope that it will be useful, but | |
24 * WITHOUT ANY WARRANTY; without even the implied warranty of | |
25 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU | |
26 * General Public License for more details. | |
27 * | |
28 * You should have received a copy of the GNU General Public License | |
29 * along with this program. If not, see <http://www.gnu.org/licenses/>. | |
30 **/ | |
31 | |
32 | |
33 #pragma once | |
34 | |
35 | |
36 #ifdef _MSC_VER | |
37 #include "../../Resources/VisualStudio/stdint.h" | |
38 #else | |
39 #include <stdint.h> | |
40 #endif | |
41 | |
42 | |
43 #ifdef WIN32 | |
44 #define ORTHANC_PLUGINS_API __declspec(dllexport) | |
45 #else | |
46 #define ORTHANC_PLUGINS_API | |
47 #endif | |
48 | |
49 | |
50 #include <stdlib.h> | |
51 | |
52 | |
53 #ifdef __cplusplus | |
54 extern "C" | |
55 { | |
56 #endif | |
57 | |
896 | 58 typedef struct OrthancPluginRestOutput_t OrthancPluginRestOutput; |
894 | 59 |
60 typedef enum | |
61 { | |
896 | 62 OrthancPluginHttpMethod_Get = 1, |
63 OrthancPluginHttpMethod_Post = 2, | |
64 OrthancPluginHttpMethod_Put = 3, | |
65 OrthancPluginHttpMethod_Delete = 4 | |
66 } OrthancPluginHttpMethod; | |
886 | 67 |
68 typedef int32_t (*OrthancPluginService) (const char* serviceName, | |
69 const void* serviceParameters); | |
70 | |
896 | 71 typedef int32_t (*OrthancPluginRestCallback) (OrthancPluginRestOutput* output, |
72 OrthancPluginHttpMethod method, | |
73 const char* url, | |
897
bafc9d592632
REST callbacks are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
896
diff
changeset
|
74 const char* const* getKeys, |
bafc9d592632
REST callbacks are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
896
diff
changeset
|
75 const char* const* getValues, |
bafc9d592632
REST callbacks are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
896
diff
changeset
|
76 uint32_t getSize, |
bafc9d592632
REST callbacks are working
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
896
diff
changeset
|
77 const char* body, uint32_t bodySize); |
894 | 78 |
79 typedef struct OrthancPluginContext_t | |
886 | 80 { |
894 | 81 void* pimpl; |
82 | |
886 | 83 const char* orthancVersion; |
894 | 84 void (*FreeBuffer) (void* buffer); |
85 | |
86 /* Logging functions */ | |
87 void (*LogError) (const char* str); | |
88 void (*LogWarning) (const char* str); | |
89 void (*LogInfo) (const char* str); | |
886 | 90 |
894 | 91 /* REST API */ |
92 void (*RegisterRestCallback) (const struct OrthancPluginContext_t* context, | |
896 | 93 const char* pathRegularExpression, |
94 OrthancPluginRestCallback callback); | |
886 | 95 |
896 | 96 void (*AnswerBuffer) (OrthancPluginRestOutput* output, |
894 | 97 const char* answer, |
98 uint32_t answerSize, | |
99 const char* mimeType); | |
886 | 100 } OrthancPluginContext; |
101 | |
102 | |
103 /** | |
894 | 104 Each plugin must define 4 functions, whose signature are: |
886 | 105 - int32_t OrthancPluginInitialize(const OrthancPluginContext*); |
106 - void OrthancPluginFinalize(); | |
888
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
886
diff
changeset
|
107 - const char* OrthancPluginGetName(); |
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
886
diff
changeset
|
108 - const char* OrthancPluginGetVersion(); |
886 | 109 |
110 nm -C -D --defined-only libPluginTest.so | |
896 | 111 **/ |
886 | 112 |
113 #ifdef __cplusplus | |
114 } | |
115 #endif |