Mercurial > hg > orthanc
annotate Plugins/OrthancCPlugin/OrthancCPlugin.h @ 894:690aeb4cb899 plugins
REST callbacks
| author | Sebastien Jodogne <s.jodogne@gmail.com> |
|---|---|
| date | Mon, 16 Jun 2014 17:31:09 +0200 |
| parents | d44b845c1c89 |
| children | c4053ac5db04 |
| 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 | |
| 894 | 58 typedef struct OrthancRestOutput_t OrthancRestOutput; |
| 59 | |
| 60 typedef enum | |
| 61 { | |
| 62 OrthancHttpMethod_Get = 1, | |
| 63 OrthancHttpMethod_Post = 2, | |
| 64 OrthancHttpMethod_Put = 3, | |
| 65 OrthancHttpMethod_Delete = 4 | |
| 66 } OrthancHttpMethod; | |
| 886 | 67 |
| 894 | 68 typedef struct OrthancRestUrl_t |
| 69 { | |
| 70 const char* path; | |
| 71 const char* const* components; | |
| 72 uint32_t componentsSize; | |
| 73 const char* const* parameters; | |
| 74 uint32_t parametersSize; | |
| 75 } OrthancRestUrl; | |
| 886 | 76 |
| 77 | |
| 78 typedef int32_t (*OrthancPluginService) (const char* serviceName, | |
| 79 const void* serviceParameters); | |
| 80 | |
| 894 | 81 typedef int32_t (*OrthancRestCallback) (OrthancRestOutput* output, |
| 82 OrthancHttpMethod method, | |
| 83 const OrthancRestUrl* url, | |
| 84 const char* body, | |
| 85 uint32_t bodySize); | |
| 86 | |
| 87 typedef struct OrthancPluginContext_t | |
| 886 | 88 { |
| 894 | 89 void* pimpl; |
| 90 | |
| 886 | 91 const char* orthancVersion; |
| 894 | 92 void (*FreeBuffer) (void* buffer); |
| 93 | |
| 94 /* Logging functions */ | |
| 95 void (*LogError) (const char* str); | |
| 96 void (*LogWarning) (const char* str); | |
| 97 void (*LogInfo) (const char* str); | |
| 886 | 98 |
| 894 | 99 /* REST API */ |
| 100 void (*RegisterRestCallback) (const struct OrthancPluginContext_t* context, | |
| 101 const char* path, | |
| 102 OrthancRestCallback callback); | |
| 886 | 103 |
| 894 | 104 void (*AnswerBuffer) (OrthancRestOutput* output, |
| 105 const char* answer, | |
| 106 uint32_t answerSize, | |
| 107 const char* mimeType); | |
| 886 | 108 } OrthancPluginContext; |
| 109 | |
| 110 | |
| 111 /** | |
| 894 | 112 Each plugin must define 4 functions, whose signature are: |
| 886 | 113 - int32_t OrthancPluginInitialize(const OrthancPluginContext*); |
| 114 - void OrthancPluginFinalize(); | |
|
888
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
886
diff
changeset
|
115 - const char* OrthancPluginGetName(); |
|
d44b845c1c89
recursive scan for plugins
Sebastien Jodogne <s.jodogne@gmail.com>
parents:
886
diff
changeset
|
116 - const char* OrthancPluginGetVersion(); |
| 886 | 117 |
| 118 nm -C -D --defined-only libPluginTest.so | |
| 119 **/ | |
| 120 | |
| 121 #ifdef __cplusplus | |
| 122 } | |
| 123 #endif |