haproxy-spoa-hub-plugin-api 0.7.0

Plugin API for haproxy-spoa-hub — define SPOE agent plugins as shared libraries
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45

# haproxy-spoa-hub-plugin-api

Plugin API for [haproxy-spoa-hub](https://gitlab.com/haproxy-haptic/haproxy-spoa-hub) —
define HAProxy SPOE agent plugins as independently compiled shared libraries.

## Quick start

```rust
#![allow(non_camel_case_types, non_local_definitions)]
use haproxy_spoa_hub_plugin_api::*;

#[derive(Debug)]
struct MyPlugin;

define_plugin!(MyPlugin, {
    fn new() -> Self { MyPlugin }

    fn init(&mut self, _context: &PluginContext)
        -> Result<(), Box<dyn std::error::Error + Send + Sync>>
    {
        Ok(())
    }

    fn name(&self) -> &str { "my-plugin" }
    fn version(&self) -> &str { env!("CARGO_PKG_VERSION") }

    fn process(
        &self,
        message: &SpoeMessage,
    ) -> Result<ProcessingResult, Box<dyn std::error::Error + Send + Sync>> {
        Ok(ProcessingResult { variables: vec![].into() })
    }
});
```

Your plugin crate must set `crate-type = ["cdylib", "rlib"]` in `Cargo.toml`.

For the full guide on writing plugins — including configuration, dependencies,
variable scoping, and JSON Schema validation — see
[Writing a Plugin](https://gitlab.com/haproxy-haptic/haproxy-spoa-hub#writing-a-plugin)
in the main repository.

## License

Apache-2.0