Struct Binding

pub struct Binding { /* private fields */ }

Protocol wrapper for a Zeek WebSocket connection.

See the module documentation for an introduction

Implementations

impl Binding

pub fn new<S>(subscriptions: S) -> Self

where S: Into<Subscriptions>,

Create a new Binding with the given Subscriptions.

let conn = Binding::new(&["topic"]);

pub fn handle_incoming(&mut self, message: Message) -> Result<(), ProtocolError>

Handle received message.

Returns true if the data was converted to a Message and added to the inbox, or false otherwise.

Errors

• returns a ProtocolError::AlreadySubscribed if we saw an unexpected ACK.
• returns a ProtocolError::UnexpectedEventPayload if an unexpected event payload was seen

pub fn outgoing(&mut self) -> Option<Bytes>

Get next data enqueued for sending.

pub fn receive_event( &mut self, ) -> Result<Option<(String, Event)>, ProtocolError>

Get the next incoming event.

Errors

• returns a ProtocolError::ZeekError if an error was received from Zeek

pub fn publish_event<S>( &mut self, topic: S, event: Event, ) -> Result<(), ProtocolError>

where S: Into<String>,

Enqueue an event for sending.

Errors

Will return ProtocolError::SendOnNonSubscribed if the binding is not subscribed to the topic of the message.

pub fn split(self) -> (Inbox, Outbox)

Split the Binding into an Inbox and Outbox.

The returned Inbox and Outbox do not enforce correct use of the protocol.