query

Documentation

Overview

Package query provides objects for specifying a query against stenographer.

Index

• Constants
• type Query
  • func NewQuery(query string) (Query, error)

Constants

const AFTER = 57357

const AGO = 57359

const AND = 57349

const BEFORE = 57356

const DURATION = 57364

const HOST = 57346

const ICMP = 57355

const IP = 57362

const IPP = 57358

const MASK = 57352

const MPLS = 57361

const NET = 57351

const NUM = 57363

const OR = 57350

const PORT = 57347

const PROTO = 57348

const TCP = 57353

const TIME = 57365

const UDP = 57354

const VLAN = 57360

Types

type Query

type Query interface {
	// LookupIn finds the set of packet positions for all packets that match the
	// query from an index file.  Users shouldn't call this directly, and should
	// instead pass the query into BlockFile's Lookup() to get back actual
	// packets.
	LookupIn(context.Context, *indexfile.IndexFile) (base.Positions, error)
	// String returns a human readable string for this query.
	String() string
	// contains filtered or unexported methods
}

Query encodes the set of packets a requester wants to get from stenographer.

func NewQuery

func NewQuery(query string) (Query, error)

NewQuery parses the given query arg and returns a query object. This query can then be passed into a blockfile to get out the set of packets which match it.

Currently, we support one simple method of parsing a query, detailed in the README.md file. Returns an error if the query string is invalid.