Skip to content

Commit

Permalink
Removing structs from API
Browse files Browse the repository at this point in the history
  • Loading branch information
jholloc committed Jan 26, 2024
1 parent 9e32074 commit 9bd184d
Show file tree
Hide file tree
Showing 113 changed files with 2,597 additions and 2,477 deletions.
8 changes: 4 additions & 4 deletions docs/creating_plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,18 +28,18 @@ called by the UDA server.

The entry function must look like:

`int entryFunction(IDAM_PLUGIN_INTERFACE*)`
`int entryFunction(UDA_PLUGIN_INTERFACE*)`

Then function can have any name — the name is specified in the plugin configuration
file, see below. The `IDAM_PLUGIN_INTERFACE` is a structure defined in `uda/plugins.h`
file, see below. The `UDA_PLUGIN_INTERFACE` is a structure defined in `uda/plugins.h`
and provides a mechanism for the plugin to interact with the UDA server — reading the
function arguments, returning the resultant data, etc. The returned `int` value specifies
the return state of the plugin call — zero for success or non-zero for an error state
(the actual error is returned via the `IDAM_PLUGIN_INTERFACE`).
(the actual error is returned via the `UDA_PLUGIN_INTERFACE`).

## Accessing function name and arguments

The function being called is provided in the `IDAM_PLUGIN_INTERFACE` structure passed into
The function being called is provided in the `UDA_PLUGIN_INTERFACE` structure passed into
entry function as a C-string (`const char*`) via:

`plugin_interface->request->function`
Expand Down
3 changes: 0 additions & 3 deletions source/CMakeLists.txt
Original file line number Diff line number Diff line change
Expand Up @@ -79,16 +79,13 @@ set( HEADERS
include/clientMDS.h
include/export.h
include/genStructs.h
include/initStructs.h
include/legacy.h
include/pluginStructs.h
include/struct.h
include/udaDefines.h
include/udaErrors.h
include/udaGetAPI.h
include/udaPlugin.h
include/udaPutAPI.h
include/udaStructs.h
include/udaTypes.h
)
install( FILES uda.h ${CMAKE_BINARY_DIR}/source/version.h DESTINATION include/uda )
Expand Down
Loading

0 comments on commit 9bd184d

Please sign in to comment.