|
typedef OrthancPluginErrorCode(* | OrthancPluginRestCallback) (OrthancPluginRestOutput *output, const char *url, const OrthancPluginHttpRequest *request) |
| Signature of a callback function that answers to a REST request.
|
|
typedef OrthancPluginErrorCode(* | OrthancPluginOnStoredInstanceCallback) (OrthancPluginDicomInstance *instance, const char *instanceId) |
| Signature of a callback function that is triggered when Orthanc receives a DICOM instance.
|
|
typedef OrthancPluginErrorCode(* | OrthancPluginOnChangeCallback) (OrthancPluginChangeType changeType, OrthancPluginResourceType resourceType, const char *resourceId) |
| Signature of a callback function that is triggered when a change happens to some DICOM resource.
|
|
typedef OrthancPluginErrorCode(* | OrthancPluginDecodeImageCallback) (OrthancPluginImage **target, const void *dicom, const uint32_t size, uint32_t frameIndex) |
| Signature of a callback function to decode a DICOM instance as an image.
|
|
typedef OrthancPluginErrorCode(* | OrthancPluginStorageCreate) (const char *uuid, const void *content, int64_t size, OrthancPluginContentType type) |
| Callback for writing to the storage area. More...
|
|
typedef OrthancPluginErrorCode(* | OrthancPluginStorageRead) (void **content, int64_t *size, const char *uuid, OrthancPluginContentType type) |
| Callback for reading from the storage area. More...
|
|
typedef OrthancPluginErrorCode(* | OrthancPluginStorageRemove) (const char *uuid, OrthancPluginContentType type) |
| Callback for removing a file from the storage area. More...
|
|
|
int | OrthancPluginCheckVersion (OrthancPluginContext *context) |
| Check the compatibility of the plugin wrt. the version of its hosting Orthanc. More...
|
|
void | OrthancPluginRegisterRestCallback (OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback callback) |
| Register a REST callback. More...
|
|
void | OrthancPluginRegisterRestCallbackNoLock (OrthancPluginContext *context, const char *pathRegularExpression, OrthancPluginRestCallback callback) |
| Register a REST callback, without locking. More...
|
|
void | OrthancPluginRegisterOnStoredInstanceCallback (OrthancPluginContext *context, OrthancPluginOnStoredInstanceCallback callback) |
| Register a callback for received instances. More...
|
|
const char * | OrthancPluginGetInstanceRemoteAet (OrthancPluginContext *context, OrthancPluginDicomInstance *instance) |
| Get the AET of a DICOM instance. More...
|
|
int64_t | OrthancPluginGetInstanceSize (OrthancPluginContext *context, OrthancPluginDicomInstance *instance) |
| Get the size of a DICOM file. More...
|
|
const char * | OrthancPluginGetInstanceData (OrthancPluginContext *context, OrthancPluginDicomInstance *instance) |
| Get the data of a DICOM file. More...
|
|
char * | OrthancPluginGetInstanceJson (OrthancPluginContext *context, OrthancPluginDicomInstance *instance) |
| Get the DICOM tag hierarchy as a JSON file. More...
|
|
char * | OrthancPluginGetInstanceSimplifiedJson (OrthancPluginContext *context, OrthancPluginDicomInstance *instance) |
| Get the DICOM tag hierarchy as a JSON file (with simplification). More...
|
|
int | OrthancPluginHasInstanceMetadata (OrthancPluginContext *context, OrthancPluginDicomInstance *instance, const char *metadata) |
| Check whether a DICOM instance is associated with some metadata. More...
|
|
const char * | OrthancPluginGetInstanceMetadata (OrthancPluginContext *context, OrthancPluginDicomInstance *instance, const char *metadata) |
| Get the value of some metadata associated with a given DICOM instance. More...
|
|
void | OrthancPluginRegisterStorageArea (OrthancPluginContext *context, OrthancPluginStorageCreate create, OrthancPluginStorageRead read, OrthancPluginStorageRemove remove) |
| Register a custom storage area. More...
|
|
void | OrthancPluginRegisterOnChangeCallback (OrthancPluginContext *context, OrthancPluginOnChangeCallback callback) |
| Register a callback to monitor changes. More...
|
|
uint32_t | OrthancPluginGetExpectedDatabaseVersion (OrthancPluginContext *context) |
| Get the expected version of the database schema. More...
|
|
OrthancPluginErrorCode | OrthancPluginStorageAreaCreate (OrthancPluginContext *context, OrthancPluginStorageArea *storageArea, const char *uuid, const void *content, uint64_t size, OrthancPluginContentType type) |
| Create a file inside the storage area. More...
|
|
OrthancPluginErrorCode | OrthancPluginStorageAreaRead (OrthancPluginContext *context, OrthancPluginMemoryBuffer *target, OrthancPluginStorageArea *storageArea, const char *uuid, OrthancPluginContentType type) |
| Read a file from the storage area. More...
|
|
OrthancPluginErrorCode | OrthancPluginStorageAreaRemove (OrthancPluginContext *context, OrthancPluginStorageArea *storageArea, const char *uuid, OrthancPluginContentType type) |
| Remove a file from the storage area. More...
|
|
OrthancPluginErrorCode | OrthancPluginReconstructMainDicomTags (OrthancPluginContext *context, OrthancPluginStorageArea *storageArea, OrthancPluginResourceType level) |
| Reconstruct the main DICOM tags. More...
|
|
OrthancPluginInstanceOrigin | OrthancPluginGetInstanceOrigin (OrthancPluginContext *context, OrthancPluginDicomInstance *instance) |
| Get the origin of a DICOM file. More...
|
|
OrthancPluginErrorCode | OrthancPluginRegisterDecodeImageCallback (OrthancPluginContext *context, OrthancPluginDecodeImageCallback callback) |
| Register a callback to handle the decoding of DICOM images. More...
|
|
typedef struct _OrthancPluginDatabaseContext_t | OrthancPluginDatabaseContext |
|
OrthancPluginDatabaseContext * | OrthancPluginRegisterDatabaseBackend (OrthancPluginContext *context, const OrthancPluginDatabaseBackend *backend, void *payload) |
|
OrthancPluginDatabaseContext * | OrthancPluginRegisterDatabaseBackendV2 (OrthancPluginContext *context, const OrthancPluginDatabaseBackend *backend, const OrthancPluginDatabaseExtensions *extensions, void *payload) |
|
Orthanc - A Lightweight, RESTful DICOM Store Copyright (C) 2012-2015 Sebastien Jodogne, Medical Physics Department, University Hospital of Liege, Belgium
This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
In addition, as a special exception, the copyright holders of this program give permission to link the code of its release with the OpenSSL project's "OpenSSL" library (or with modified versions of it that use the same license as the "OpenSSL" library), and distribute the linked executables. You must obey the GNU General Public License in all respects for all of the code used other than "OpenSSL". If you modify file(s) with this exception, you may extend this exception to your version of the file(s), but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version. If you delete this exception statement from all source files in the program, then also delete it here.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/. Opaque structure that represents the context of a custom database engine.
This function registers a REST callback against a regular expression for a URI. This function must be called during the initialization of the plugin, i.e. inside the OrthancPluginInitialize() public function.
Contrarily to OrthancPluginRegisterRestCallback(), the callback will NOT be invoked in mutual exclusion. This can be useful for high-performance plugins that must handle concurrent requests (Orthanc uses a pool of threads, one thread being assigned to each incoming HTTP request). Of course, it is up to the plugin to implement the required locking mechanisms.
- Parameters
-
context | The Orthanc plugin context, as received by OrthancPluginInitialize(). |
pathRegularExpression | Regular expression for the URI. May contain groups. |
callback | The callback function to handle the REST call. |
- See also
- OrthancPluginRegisterRestCallback()