grpc

Documentation

Overview

Package grpc provides the basic interfaces to build a gRPC+Protobuf flows client & server

Index

• type ClientConnection
  • func ConnectClient(address string) (*ClientConnection, error)
  • func (cp *ClientConnection) Client() pbflow.CollectorClient
  • func (cp *ClientConnection) Close() error
• type CollectorOption
  • func WithGRPCServerOptions(options ...grpc.ServerOption) CollectorOption
• type CollectorServer
  • func StartCollector(port int, recordForwarder chan<- *pbflow.Records, options ...CollectorOption) (*CollectorServer, error)
  • func (c *CollectorServer) Close() error

Types

type ClientConnection

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

ClientConnection wraps a gRPC+protobuf connection

func ConnectClient

func ConnectClient(address string) (*ClientConnection, error)

func (*ClientConnection) Client

func (cp *ClientConnection) Client() pbflow.CollectorClient

func (*ClientConnection) Close

func (cp *ClientConnection) Close() error

type CollectorOption

type CollectorOption func(options *collectorOptions)

CollectorOption allows overriding the default configuration of the CollectorServer instance. Use them in the StartCollector function.

func WithGRPCServerOptions

func WithGRPCServerOptions(options ...grpc.ServerOption) CollectorOption

type CollectorServer

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

CollectorServer wraps a Flow Collector connection & session

func StartCollector

func StartCollector(
	port int, recordForwarder chan<- *pbflow.Records, options ...CollectorOption,
) (*CollectorServer, error)

StartCollector listens in background for gRPC+Protobuf flows in the given port, and forwards each set of *pbflow.Records by the provided channel.

func (*CollectorServer) Close

func (c *CollectorServer) Close() error