# Functions
Address creates an encoding.Data of address type given the provided net.IP value.
Boolean creates an encoding.Data of boolean type given the provided bool value.
Count creates an encoding.Data of count type given the provided uint64 value.
EnumValue creates an encoding.Data of enum-value type given the provided string value.
Integer creates an encoding.Data of integer type given the provided int64 value.
NewEvent is a helper to create an encoding.Event using variadic arguments.
None creates an encoding.Data of none type.
ParseProtocol attempts to convert a string to a Protocol.
No description provided by the author
ParseType attempts to convert a string to a Type.
Port creates an encoding.Data of port type given the provided encoding.Service value.
Real creates an encoding.Data of real type given the provided float64 value.
Set creates an encoding.Data of set type given the provided map of Data to struct{} value.
String creates an encoding.Data of string type given the provided string value.
Subnet creates an encoding.Data of subnet type given the provided net.IPNet value.
Table creates an encoding.Data of table type given the provided map of Data to Data value.
Timespan creates an encoding.Data of timespan type given the provided time.Duration value.
Timespan creates an encoding.Data of timestamp type given the provided time.Time value.
Vector creates an encoding.Data of vector type given the provided encoding.Data values.
# Constants
No description provided by the author
ProtocolICMP is a Protocol of type ICMP.
ProtocolTCP is a Protocol of type TCP.
ProtocolUDP is a Protocol of type UDP.
ProtocolUnknown is a Protocol of type Unknown.
TypeAddress is a Type of type Address.
TypeBoolean is a Type of type Boolean.
TypeCount is a Type of type Count.
TypeEnumValue is a Type of type EnumValue.
TypeInteger is a Type of type Integer.
TypeNone is a Type of type None.
TypePort is a Type of type Port.
TypeReal is a Type of type Real.
TypeSet is a Type of type Set.
TypeString is a Type of type String.
TypeSubnet is a Type of type Subnet.
TypeTable is a Type of type Table.
TypeTimespan is a Type of type Timespan.
TypeTimestamp is a Type of type Timestamp.
TypeVector is a Type of type Vector.
# Variables
No description provided by the author
No description provided by the author
# Structs
AckMessage is the handshake sent by broker on connect.
Data is the recursive type/value structure used by the Zeek broker websocket encoding.
DataMessage handles the encoding of "data-message" structures (which are used to represent events and errors).
DataMessageUnknownTypeError is raised when we receive a DataMessage that is neither an event or an error from broker.
ErrorMessage encodes error messages from broker.
Event is a more convenient representation of a Zeek event (as opposed to an encoding.DataMessage with special contents).
EventMetaEntry os a (id, value) tuple used to encode Zeek event metadata.
No description provided by the author
# Type aliases
Protocol represents an L4 protocol
ENUM(
TCP = "tcp"
UDP = "udp"
ICMP = "icmp"
Unknown = "?"
)
*/.
Type represents the types specific to Zeek broker websocket encoding
ENUM(
Boolean = "boolean" // Native JSON boolean (maps to bool)
Count = "count" // 64 bit unsigned integer (maps to uint64)
Integer = "integer" // Native JSON (signed) integer (maps to int64)
Real = "real" // Native JSON "number" type (maps to float64)
Timespan = "timespan" // String-encoded time span (maps to time.Duration)
Timestamp = "timestamp" // ISO 8601 encoded time in YYYY-MM-DDThh:mm:ss.sss format (maps to time.Time)
String = "string" // Native JSON string (maps to string)
EnumValue = "enum-value" // Zeek enum value mapped to native JSON string (maps to string)
Address = "address" // String-encoded IPv4/IPv6 address (maps to net.Addr)
Subnet = "subnet" // String-encoded IPv4/IPv6 subnet in <address>/<prefix-length> format (maps to net.IPNet)
Port = "port" // String-encoded service port in <port>/<protocol> format (maps to encoding.Service)
Vector = "vector" // Sequence of encoding.Data (maps to []Data)
Set = "set" // Sequence of encoding.Data with distinct objects (maps to map[Data]struct{})
Table = "table" // Map of encoding.Data keys to encoding.Data values (maps to map[Data]Data)
None = "none" // JSON empty object, maps to nil
)
*/.