client

Documentation

Index

• type Client
  • func NewForConfig(config *Config) (*Client, error)
  • func (c *Client) Close() error
  • func (c *Client) Output() (output.ServiceClient, error)
  • func (c *Client) Version() (version.ServiceClient, error)
• type Config

Examples

• Client
• Client (OutputSubscribe)
• Client (Version)

Types

type Client

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

Client is a wrapper for the gRPC connection it allows to connect to a Falco gRPC server. It is created using the function NewForConfig(config *Config) .

Example

The simplest use of a Client, just create and Close it.

Example (OutputSubscribe)

A client that is created and then used to Subscribe to Falco output events

Example (Version)

func NewForConfig

func NewForConfig(config *Config) (*Client, error)

NewForConfig is used to create a new Falco gRPC client.

func (*Client) Close

func (c *Client) Close() error

Close the connection to the falco gRPC server.

func (*Client) Output

func (c *Client) Output() (output.ServiceClient, error)

Output is the client for Falco Outputs. When using it you can use `subscribe()` to receive a stream of Falco output events.

func (*Client) Version

func (c *Client) Version() (version.ServiceClient, error)

Version it the client for Falco Version API. When using it you can use `version()` to receive the Falco version.

type Config

type Config struct {
	Hostname   string
	Port       uint16
	CertFile   string
	KeyFile    string
	CARootFile string
}

Config is the configuration definition for connecting to a Falco gRPC server.