ConcatenateBytes

The ConcatenateBytes filter's job is to add a byte packet to either the beginning or end of each UDP packet that passes through. This is commonly used to provide an auth token to each packet, so they can be routed appropriately.

Filter name

quilkin.filters.concatenate_bytes.v1alpha1.ConcatenateBytes

Configuration Examples

#![allow(unused)]
fn main() {
let yaml = "
version: v1alpha1
static:
  filters:
    - name: quilkin.filters.concatenate_bytes.v1alpha1.ConcatenateBytes
      config:
          on_read: APPEND
          on_write: DO_NOTHING
          bytes: MXg3aWp5Ng==
  endpoints:
    - address: 127.0.0.1:7001
";
let config = quilkin::config::Config::from_reader(yaml.as_bytes()).unwrap();
assert_eq!(config.source.get_static_filters().unwrap().len(), 1);
quilkin::Builder::from(std::sync::Arc::new(config)).validate().unwrap();
}

Configuration Options (Rust Doc)

---
$schema: "http://json-schema.org/draft-07/schema#"
title: Config
description: "Config represents a `ConcatenateBytes` filter configuration."
type: object
required:
  - bytes
properties:
  bytes:
    type: array
    items:
      type: integer
      format: uint8
      minimum: 0.0
  on_read:
    description: "Whether or not to `append` or `prepend` or `do nothing` on Filter `Read`"
    default: DO_NOTHING
    allOf:
      - $ref: "#/definitions/Strategy"
  on_write:
    description: "Whether or not to `append` or `prepend` or `do nothing` on Filter `Write`"
    default: DO_NOTHING
    allOf:
      - $ref: "#/definitions/Strategy"
definitions:
  Strategy:
    type: string
    enum:
      - APPEND
      - PREPEND
      - DO_NOTHING

Metrics

This filter currently exports no metrics.