udf

package
v1.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 26, 2016 License: MIT Imports: 10 Imported by: 0

Documentation

Overview

Package udf is a generated protocol buffer package.

It is generated from these files: 

udf.proto

It has these top-level messages: 

InfoRequest
InfoResponse
OptionInfo
InitRequest
Option
OptionValue
InitResponse
SnapshotRequest
SnapshotResponse
RestoreRequest
RestoreResponse
KeepaliveRequest
KeepaliveResponse
ErrorResponse
BeginBatch
Point
EndBatch
Request
Response

Index

Constants

This section is empty.

Variables

View Source 
var EdgeType_name = map[int32]string{
	0: "STREAM",
	1: "BATCH",
}
View Source 
var EdgeType_value = map[string]int32{
	"STREAM": 0,
	"BATCH":  1,
}
View Source 
var ErrServerStopped = errors.New("server already stopped")
View Source 
var ValueType_name = map[int32]string{
	0: "BOOL",
	1: "INT",
	2: "DOUBLE",
	3: "STRING",
	4: "DURATION",
}
View Source 
var ValueType_value = map[string]int32{
	"BOOL":     0,
	"INT":      1,
	"DOUBLE":   2,
	"STRING":   3,
	"DURATION": 4,
}

Functions

func ReadMessage 

func ReadMessage(buf *[]byte, r ByteReadReader, msg proto.Message) error

Read a message from io.ByteReader by first reading a varint size, and then reading and decoding the message object. If buf is not big enough a new buffer will be allocated to replace buf.

func WriteMessage 

func WriteMessage(msg proto.Message, w io.Writer) error

Write the message to the io.Writer with a varint size header.

Types

type BeginBatch 

type BeginBatch struct {
	Name   string            `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	Group  string            `protobuf:"bytes,2,opt,name=group" json:"group,omitempty"`
	Tags   map[string]string `` /* 128-byte string literal not displayed */
	Size   int64             `protobuf:"varint,4,opt,name=size" json:"size,omitempty"`
	ByName bool              `protobuf:"varint,5,opt,name=byName" json:"byName,omitempty"`
}

Indicates the beginning of a batch. All subsequent points should be considered part of the batch until EndBatch arrives. This includes grouping. Batches of differing groups may not be interleaved.

All the meta data but tmax is provided, since tmax may not be known at the beginning of a batch.

Size is the number of points in the batch. If size is 0 then the batch has an undetermined size.

func (*BeginBatch) Descriptor added in v0.11.0 

func (*BeginBatch) Descriptor() ([]byte, []int)

func (*BeginBatch) GetTags added in v0.10.1 

func (m *BeginBatch) GetTags() map[string]string

func (*BeginBatch) ProtoMessage 

func (*BeginBatch) ProtoMessage()

func (*BeginBatch) Reset 

func (m *BeginBatch) Reset()

func (*BeginBatch) String 

func (m *BeginBatch) String() string

type ByteReadReader 

type ByteReadReader interface {
	io.Reader
	io.ByteReader
}

Interface for reading messages If you have an io.Reader wrap your reader in a bufio Reader to stasify this interface.

Example: brr := bufio.NewReader(reader)

type EdgeType 

type EdgeType int32
const (
	EdgeType_STREAM EdgeType = 0
	EdgeType_BATCH  EdgeType = 1
)

func (EdgeType) EnumDescriptor added in v0.11.0 

func (EdgeType) EnumDescriptor() ([]byte, []int)

func (EdgeType) String 

func (x EdgeType) String() string

type EndBatch 

type EndBatch struct {
	Name   string            `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	Group  string            `protobuf:"bytes,2,opt,name=group" json:"group,omitempty"`
	Tmax   int64             `protobuf:"varint,3,opt,name=tmax" json:"tmax,omitempty"`
	Tags   map[string]string `` /* 128-byte string literal not displayed */
	ByName bool              `protobuf:"varint,5,opt,name=byName" json:"byName,omitempty"`
}

Indicates the end of a batch and contains all meta data associated with the batch. The same meta information is provided for ease of use with the addition of tmax since it may not be know at BeginBatch.

func (*EndBatch) Descriptor added in v0.11.0 

func (*EndBatch) Descriptor() ([]byte, []int)

func (*EndBatch) GetTags 

func (m *EndBatch) GetTags() map[string]string

func (*EndBatch) ProtoMessage 

func (*EndBatch) ProtoMessage()

func (*EndBatch) Reset 

func (m *EndBatch) Reset()

func (*EndBatch) String 

func (m *EndBatch) String() string

type ErrorResponse 

type ErrorResponse struct {
	Error string `protobuf:"bytes,1,opt,name=error" json:"error,omitempty"`
}

Sent from the process to Kapacitor indicating an error has occurred. If an ErrorResponse is received, Kapacitor will terminate the process.

func (*ErrorResponse) Descriptor added in v0.11.0 

func (*ErrorResponse) Descriptor() ([]byte, []int)

func (*ErrorResponse) ProtoMessage 

func (*ErrorResponse) ProtoMessage()

func (*ErrorResponse) Reset 

func (m *ErrorResponse) Reset()

func (*ErrorResponse) String 

func (m *ErrorResponse) String() string

type Info added in v0.13.0 

type Info struct {
	Wants    EdgeType
	Provides EdgeType
	Options  map[string]*OptionInfo
}

type InfoRequest 

type InfoRequest struct {
}

Request that the process return information about available Options.

func (*InfoRequest) Descriptor added in v0.11.0 

func (*InfoRequest) Descriptor() ([]byte, []int)

func (*InfoRequest) ProtoMessage 

func (*InfoRequest) ProtoMessage()

func (*InfoRequest) Reset 

func (m *InfoRequest) Reset()

func (*InfoRequest) String 

func (m *InfoRequest) String() string

type InfoResponse 

type InfoResponse struct {
	Wants    EdgeType               `protobuf:"varint,1,opt,name=wants,enum=udf.EdgeType" json:"wants,omitempty"`
	Provides EdgeType               `protobuf:"varint,2,opt,name=provides,enum=udf.EdgeType" json:"provides,omitempty"`
	Options  map[string]*OptionInfo `` /* 134-byte string literal not displayed */
}

func (*InfoResponse) Descriptor added in v0.11.0 

func (*InfoResponse) Descriptor() ([]byte, []int)

func (*InfoResponse) GetOptions 

func (m *InfoResponse) GetOptions() map[string]*OptionInfo

func (*InfoResponse) ProtoMessage 

func (*InfoResponse) ProtoMessage()

func (*InfoResponse) Reset 

func (m *InfoResponse) Reset()

func (*InfoResponse) String 

func (m *InfoResponse) String() string

type InitRequest 

type InitRequest struct {
	Options []*Option `protobuf:"bytes,1,rep,name=options" json:"options,omitempty"`
}

Request that the process initialize itself with the provided options.

func (*InitRequest) Descriptor added in v0.11.0 

func (*InitRequest) Descriptor() ([]byte, []int)

func (*InitRequest) GetOptions 

func (m *InitRequest) GetOptions() []*Option

func (*InitRequest) ProtoMessage 

func (*InitRequest) ProtoMessage()

func (*InitRequest) Reset 

func (m *InitRequest) Reset()

func (*InitRequest) String 

func (m *InitRequest) String() string

type InitResponse 

type InitResponse struct {
	Success bool   `protobuf:"varint,1,opt,name=success" json:"success,omitempty"`
	Error   string `protobuf:"bytes,2,opt,name=error" json:"error,omitempty"`
}

Respond to Kapacitor whether initialization was successful.

func (*InitResponse) Descriptor added in v0.11.0 

func (*InitResponse) Descriptor() ([]byte, []int)

func (*InitResponse) ProtoMessage 

func (*InitResponse) ProtoMessage()

func (*InitResponse) Reset 

func (m *InitResponse) Reset()

func (*InitResponse) String 

func (m *InitResponse) String() string

type Interface added in v0.13.0 

type Interface interface {
	Open() error
	Info() (Info, error)
	Init(options []*Option) error
	Abort(err error)
	Close() error

	Snapshot() ([]byte, error)
	Restore(snapshot []byte) error

	PointIn() chan<- models.Point
	BatchIn() chan<- models.Batch
	PointOut() <-chan models.Point
	BatchOut() <-chan models.Batch
}

Interface for communicating with a UDF

type KeepaliveRequest 

type KeepaliveRequest struct {
	// The number of nanoseconds since the epoch.
	// Used only for debugging keepalive requests.
	Time int64 `protobuf:"varint,1,opt,name=time" json:"time,omitempty"`
}

Request that the process respond with a Keepalive to verify it is responding.

func (*KeepaliveRequest) Descriptor added in v0.11.0 

func (*KeepaliveRequest) Descriptor() ([]byte, []int)

func (*KeepaliveRequest) ProtoMessage 

func (*KeepaliveRequest) ProtoMessage()

func (*KeepaliveRequest) Reset 

func (m *KeepaliveRequest) Reset()

func (*KeepaliveRequest) String 

func (m *KeepaliveRequest) String() string

type KeepaliveResponse 

type KeepaliveResponse struct {
	// The number of nanoseconds since the epoch.
	// Used only for debugging keepalive requests.
	Time int64 `protobuf:"varint,1,opt,name=time" json:"time,omitempty"`
}

Respond to KeepaliveRequest

func (*KeepaliveResponse) Descriptor added in v0.11.0 

func (*KeepaliveResponse) Descriptor() ([]byte, []int)

func (*KeepaliveResponse) ProtoMessage 

func (*KeepaliveResponse) ProtoMessage()

func (*KeepaliveResponse) Reset 

func (m *KeepaliveResponse) Reset()

func (*KeepaliveResponse) String 

func (m *KeepaliveResponse) String() string

type Option 

type Option struct {
	Name   string         `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	Values []*OptionValue `protobuf:"bytes,2,rep,name=values" json:"values,omitempty"`
}

func (*Option) Descriptor added in v0.11.0 

func (*Option) Descriptor() ([]byte, []int)

func (*Option) GetValues 

func (m *Option) GetValues() []*OptionValue

func (*Option) ProtoMessage 

func (*Option) ProtoMessage()

func (*Option) Reset 

func (m *Option) Reset()

func (*Option) String 

func (m *Option) String() string

type OptionInfo 

type OptionInfo struct {
	ValueTypes []ValueType `protobuf:"varint,1,rep,name=valueTypes,enum=udf.ValueType" json:"valueTypes,omitempty"`
}

func (*OptionInfo) Descriptor added in v0.11.0 

func (*OptionInfo) Descriptor() ([]byte, []int)

func (*OptionInfo) ProtoMessage 

func (*OptionInfo) ProtoMessage()

func (*OptionInfo) Reset 

func (m *OptionInfo) Reset()

func (*OptionInfo) String 

func (m *OptionInfo) String() string

type OptionValue 

type OptionValue struct {
	Type ValueType `protobuf:"varint,1,opt,name=type,enum=udf.ValueType" json:"type,omitempty"`
	// Types that are valid to be assigned to Value:
	//	*OptionValue_BoolValue
	//	*OptionValue_IntValue
	//	*OptionValue_DoubleValue
	//	*OptionValue_StringValue
	//	*OptionValue_DurationValue
	Value isOptionValue_Value `protobuf_oneof:"value"`
}

func (*OptionValue) Descriptor added in v0.11.0 

func (*OptionValue) Descriptor() ([]byte, []int)

func (*OptionValue) GetBoolValue 

func (m *OptionValue) GetBoolValue() bool

func (*OptionValue) GetDoubleValue 

func (m *OptionValue) GetDoubleValue() float64

func (*OptionValue) GetDurationValue 

func (m *OptionValue) GetDurationValue() int64

func (*OptionValue) GetIntValue 

func (m *OptionValue) GetIntValue() int64

func (*OptionValue) GetStringValue 

func (m *OptionValue) GetStringValue() string

func (*OptionValue) GetValue 

func (m *OptionValue) GetValue() isOptionValue_Value

func (*OptionValue) ProtoMessage 

func (*OptionValue) ProtoMessage()

func (*OptionValue) Reset 

func (m *OptionValue) Reset()

func (*OptionValue) String 

func (m *OptionValue) String() string

func (*OptionValue) XXX_OneofFuncs 

func (*OptionValue) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type OptionValue_BoolValue 

type OptionValue_BoolValue struct {
	BoolValue bool `protobuf:"varint,2,opt,name=boolValue,oneof"`
}

type OptionValue_DoubleValue 

type OptionValue_DoubleValue struct {
	DoubleValue float64 `protobuf:"fixed64,4,opt,name=doubleValue,oneof"`
}

type OptionValue_DurationValue 

type OptionValue_DurationValue struct {
	DurationValue int64 `protobuf:"varint,6,opt,name=durationValue,oneof"`
}

type OptionValue_IntValue 

type OptionValue_IntValue struct {
	IntValue int64 `protobuf:"varint,3,opt,name=intValue,oneof"`
}

type OptionValue_StringValue 

type OptionValue_StringValue struct {
	StringValue string `protobuf:"bytes,5,opt,name=stringValue,oneof"`
}

type Point 

type Point struct {
	Time            int64              `protobuf:"varint,1,opt,name=time" json:"time,omitempty"`
	Name            string             `protobuf:"bytes,2,opt,name=name" json:"name,omitempty"`
	Database        string             `protobuf:"bytes,3,opt,name=database" json:"database,omitempty"`
	RetentionPolicy string             `protobuf:"bytes,4,opt,name=retentionPolicy" json:"retentionPolicy,omitempty"`
	Group           string             `protobuf:"bytes,5,opt,name=group" json:"group,omitempty"`
	Dimensions      []string           `protobuf:"bytes,6,rep,name=dimensions" json:"dimensions,omitempty"`
	Tags            map[string]string  `` /* 128-byte string literal not displayed */
	FieldsDouble    map[string]float64 `` /* 146-byte string literal not displayed */
	FieldsInt       map[string]int64   `` /* 139-byte string literal not displayed */
	FieldsString    map[string]string  `` /* 145-byte string literal not displayed */
	ByName          bool               `protobuf:"varint,11,opt,name=byName" json:"byName,omitempty"`
}

Message containing information about a single data point. Can be sent on it's own or bookended by BeginBatch and EndBatch messages.

func (*Point) Descriptor added in v0.11.0 

func (*Point) Descriptor() ([]byte, []int)

func (*Point) GetFieldsDouble 

func (m *Point) GetFieldsDouble() map[string]float64

func (*Point) GetFieldsInt 

func (m *Point) GetFieldsInt() map[string]int64

func (*Point) GetFieldsString 

func (m *Point) GetFieldsString() map[string]string

func (*Point) GetTags 

func (m *Point) GetTags() map[string]string

func (*Point) ProtoMessage 

func (*Point) ProtoMessage()

func (*Point) Reset 

func (m *Point) Reset()

func (*Point) String 

func (m *Point) String() string

type Request 

type Request struct {
	// Types that are valid to be assigned to Message:
	//	*Request_Info
	//	*Request_Init
	//	*Request_Keepalive
	//	*Request_Snapshot
	//	*Request_Restore
	//	*Request_Begin
	//	*Request_Point
	//	*Request_End
	Message isRequest_Message `protobuf_oneof:"message"`
}

Request message wrapper -- sent from Kapacitor to process

func (*Request) Descriptor added in v0.11.0 

func (*Request) Descriptor() ([]byte, []int)

func (*Request) GetBegin 

func (m *Request) GetBegin() *BeginBatch

func (*Request) GetEnd 

func (m *Request) GetEnd() *EndBatch

func (*Request) GetInfo 

func (m *Request) GetInfo() *InfoRequest

func (*Request) GetInit 

func (m *Request) GetInit() *InitRequest

func (*Request) GetKeepalive 

func (m *Request) GetKeepalive() *KeepaliveRequest

func (*Request) GetMessage 

func (m *Request) GetMessage() isRequest_Message

func (*Request) GetPoint 

func (m *Request) GetPoint() *Point

func (*Request) GetRestore 

func (m *Request) GetRestore() *RestoreRequest

func (*Request) GetSnapshot 

func (m *Request) GetSnapshot() *SnapshotRequest

func (*Request) ProtoMessage 

func (*Request) ProtoMessage()

func (*Request) Reset 

func (m *Request) Reset()

func (*Request) String 

func (m *Request) String() string

func (*Request) XXX_OneofFuncs 

func (*Request) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type Request_Begin 

type Request_Begin struct {
	Begin *BeginBatch `protobuf:"bytes,16,opt,name=begin,oneof"`
}

type Request_End 

type Request_End struct {
	End *EndBatch `protobuf:"bytes,18,opt,name=end,oneof"`
}

type Request_Info 

type Request_Info struct {
	Info *InfoRequest `protobuf:"bytes,1,opt,name=info,oneof"`
}

type Request_Init 

type Request_Init struct {
	Init *InitRequest `protobuf:"bytes,2,opt,name=init,oneof"`
}

type Request_Keepalive 

type Request_Keepalive struct {
	Keepalive *KeepaliveRequest `protobuf:"bytes,3,opt,name=keepalive,oneof"`
}

type Request_Point 

type Request_Point struct {
	Point *Point `protobuf:"bytes,17,opt,name=point,oneof"`
}

type Request_Restore 

type Request_Restore struct {
	Restore *RestoreRequest `protobuf:"bytes,5,opt,name=restore,oneof"`
}

type Request_Snapshot 

type Request_Snapshot struct {
	Snapshot *SnapshotRequest `protobuf:"bytes,4,opt,name=snapshot,oneof"`
}

type Response 

type Response struct {
	// Types that are valid to be assigned to Message:
	//	*Response_Info
	//	*Response_Init
	//	*Response_Keepalive
	//	*Response_Snapshot
	//	*Response_Restore
	//	*Response_Error
	//	*Response_Begin
	//	*Response_Point
	//	*Response_End
	Message isResponse_Message `protobuf_oneof:"message"`
}

Response message wrapper -- sent from process to Kapacitor

func (*Response) Descriptor added in v0.11.0 

func (*Response) Descriptor() ([]byte, []int)

func (*Response) GetBegin 

func (m *Response) GetBegin() *BeginBatch

func (*Response) GetEnd 

func (m *Response) GetEnd() *EndBatch

func (*Response) GetError 

func (m *Response) GetError() *ErrorResponse

func (*Response) GetInfo 

func (m *Response) GetInfo() *InfoResponse

func (*Response) GetInit 

func (m *Response) GetInit() *InitResponse

func (*Response) GetKeepalive 

func (m *Response) GetKeepalive() *KeepaliveResponse

func (*Response) GetMessage 

func (m *Response) GetMessage() isResponse_Message

func (*Response) GetPoint 

func (m *Response) GetPoint() *Point

func (*Response) GetRestore 

func (m *Response) GetRestore() *RestoreResponse

func (*Response) GetSnapshot 

func (m *Response) GetSnapshot() *SnapshotResponse

func (*Response) ProtoMessage 

func (*Response) ProtoMessage()

func (*Response) Reset 

func (m *Response) Reset()

func (*Response) String 

func (m *Response) String() string

func (*Response) XXX_OneofFuncs 

func (*Response) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, func(msg proto.Message, tag, wire int, b *proto.Buffer) (bool, error), func(msg proto.Message) (n int), []interface{})

XXX_OneofFuncs is for the internal use of the proto package.

type Response_Begin 

type Response_Begin struct {
	Begin *BeginBatch `protobuf:"bytes,16,opt,name=begin,oneof"`
}

type Response_End 

type Response_End struct {
	End *EndBatch `protobuf:"bytes,18,opt,name=end,oneof"`
}

type Response_Error 

type Response_Error struct {
	Error *ErrorResponse `protobuf:"bytes,6,opt,name=error,oneof"`
}

type Response_Info 

type Response_Info struct {
	Info *InfoResponse `protobuf:"bytes,1,opt,name=info,oneof"`
}

type Response_Init 

type Response_Init struct {
	Init *InitResponse `protobuf:"bytes,2,opt,name=init,oneof"`
}

type Response_Keepalive 

type Response_Keepalive struct {
	Keepalive *KeepaliveResponse `protobuf:"bytes,3,opt,name=keepalive,oneof"`
}

type Response_Point 

type Response_Point struct {
	Point *Point `protobuf:"bytes,17,opt,name=point,oneof"`
}

type Response_Restore 

type Response_Restore struct {
	Restore *RestoreResponse `protobuf:"bytes,5,opt,name=restore,oneof"`
}

type Response_Snapshot 

type Response_Snapshot struct {
	Snapshot *SnapshotResponse `protobuf:"bytes,4,opt,name=snapshot,oneof"`
}

type RestoreRequest 

type RestoreRequest struct {
	Snapshot []byte `protobuf:"bytes,1,opt,name=snapshot,proto3" json:"snapshot,omitempty"`
}

Request that the process restore its state from a snapshot.

func (*RestoreRequest) Descriptor added in v0.11.0 

func (*RestoreRequest) Descriptor() ([]byte, []int)

func (*RestoreRequest) ProtoMessage 

func (*RestoreRequest) ProtoMessage()

func (*RestoreRequest) Reset 

func (m *RestoreRequest) Reset()

func (*RestoreRequest) String 

func (m *RestoreRequest) String() string

type RestoreResponse 

type RestoreResponse struct {
	Success bool   `protobuf:"varint,1,opt,name=success" json:"success,omitempty"`
	Error   string `protobuf:"bytes,2,opt,name=error" json:"error,omitempty"`
}

Respond with success or failure to a RestoreRequest

func (*RestoreResponse) Descriptor added in v0.11.0 

func (*RestoreResponse) Descriptor() ([]byte, []int)

func (*RestoreResponse) ProtoMessage 

func (*RestoreResponse) ProtoMessage()

func (*RestoreResponse) Reset 

func (m *RestoreResponse) Reset()

func (*RestoreResponse) String 

func (m *RestoreResponse) String() string

type Server added in v0.13.0 

type Server struct {
	// contains filtered or unexported fields
}

Server provides an implementation for the core communication with UDFs. The Server provides only a partial implementation of udf.Interface as it is expected that setup and teardown will be necessary to create a Server. As such the Open and Close methods are not implemented.

Once a Server is created and started the owner can send points or batches to the UDF by writing them to the PointIn or BatchIn channels respectively, and according to the type of UDF created.

The Server may be Aborted at anytime for various reasons. It is the owner's responsibility via the abortCallback to stop writing to the *In channels since no more selects on the channels will be performed.

Calling Stop on the Server should only be done once the owner has stopped writing to the *In channel, at which point the remaining data will be processed and the UDF will be allowed to clean up.

Callling Info returns information about available options the UDF has.

Calling Init is required to process data. The behavior is undefined if you send points/batches to the Server without calling Init.

func NewServer added in v0.13.0 

func NewServer(
	in ByteReadReader,
	out io.WriteCloser,
	l *log.Logger,
	timeout time.Duration,
	abortCallback func(),
	killCallback func(),
) *Server

func (*Server) Abort added in v0.13.0 

func (s *Server) Abort(err error)

Abort the server. Data in-flight will not be processed. Give a reason for aborting via the err parameter.

func (*Server) BatchIn added in v0.13.0 

func (s *Server) BatchIn() chan<- models.Batch

func (*Server) BatchOut added in v0.13.0 

func (s *Server) BatchOut() <-chan models.Batch

func (*Server) Info added in v0.13.0 

func (s *Server) Info() (Info, error)

Get information about the process, available options etc. Info need not be called every time a process is started.

func (*Server) Init added in v0.13.0 

func (s *Server) Init(options []*Option) error

Initialize the process with a set of Options. Calling Init is required even if you do not have any specific Options, just pass nil

func (*Server) PointIn added in v0.13.0 

func (s *Server) PointIn() chan<- models.Point

func (*Server) PointOut added in v0.13.0 

func (s *Server) PointOut() <-chan models.Point

func (*Server) Restore added in v0.13.0 

func (s *Server) Restore(snapshot []byte) error

Request to restore a snapshot.

func (*Server) Snapshot added in v0.13.0 

func (s *Server) Snapshot() ([]byte, error)

Request a snapshot from the process.

func (*Server) Start added in v0.13.0 

func (s *Server) Start() error

Start the Server

func (*Server) Stop added in v0.13.0 

func (s *Server) Stop() error

Stop the Server cleanly.

Calling Stop should only be done once the owner has stopped writing to the *In channel, at which point the remaining data will be processed and the subprocess will be allowed to exit cleanly.

func (*Server) WaitIO added in v0.13.0 

func (s *Server) WaitIO()

Wait for all IO to stop on the in/out objects.

type SnapshotRequest 

type SnapshotRequest struct {
}

Request that the process provide a snapshot of its state.

func (*SnapshotRequest) Descriptor added in v0.11.0 

func (*SnapshotRequest) Descriptor() ([]byte, []int)

func (*SnapshotRequest) ProtoMessage 

func (*SnapshotRequest) ProtoMessage()

func (*SnapshotRequest) Reset 

func (m *SnapshotRequest) Reset()

func (*SnapshotRequest) String 

func (m *SnapshotRequest) String() string

type SnapshotResponse 

type SnapshotResponse struct {
	Snapshot []byte `protobuf:"bytes,1,opt,name=snapshot,proto3" json:"snapshot,omitempty"`
}

Respond to Kapacitor with a serialized snapshot of the running state.

func (*SnapshotResponse) Descriptor added in v0.11.0 

func (*SnapshotResponse) Descriptor() ([]byte, []int)

func (*SnapshotResponse) ProtoMessage 

func (*SnapshotResponse) ProtoMessage()

func (*SnapshotResponse) Reset 

func (m *SnapshotResponse) Reset()

func (*SnapshotResponse) String 

func (m *SnapshotResponse) String() string

type ValueType 

type ValueType int32
const (
	ValueType_BOOL     ValueType = 0
	ValueType_INT      ValueType = 1
	ValueType_DOUBLE   ValueType = 2
	ValueType_STRING   ValueType = 3
	ValueType_DURATION ValueType = 4
)

func (ValueType) EnumDescriptor added in v0.11.0 

func (ValueType) EnumDescriptor() ([]byte, []int)

func (ValueType) String 

func (x ValueType) String() string

Source Files

View all Source files

Directories

Path Synopsis
examples/mirror
examples/moving_avg
examples/outliers

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.