api

Documentation

Index

• type Client
  • func (c *Client) Close()
  • func (c *Client) Event() eventclient.EventClient
  • func (c *Client) KV() kvclient.KVClient
  • func (c *Client) Queue() queueclient.QueueClient
  • func (c *Client) Storage() storageclient.StorageClient
• type NitricClient
  • func New() (NitricClient, error)

Types

type Client

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

Client - NitricClient gRPC implementation

func (*Client) Close

func (c *Client) Close()

Close - close the nitric client, its connection to the nitric service and all service clients

func (*Client) Event

func (c *Client) Event() eventclient.EventClient

Event - returns an event service client

func (*Client) KV

func (c *Client) KV() kvclient.KVClient

KV - returns a kv service client

func (*Client) Queue

func (c *Client) Queue() queueclient.QueueClient

Queue - returns a queue service client

func (*Client) Storage

func (c *Client) Storage() storageclient.StorageClient

Storage - returns a storage client

type NitricClient

type NitricClient interface {
	KV() kvclient.KVClient
	Event() eventclient.EventClient
	Queue() queueclient.QueueClient
	Storage() storageclient.StorageClient
	Close()
}

NitricClient - provider services client TODO: Look at adding generics for scope: https://blog.golang.org/generics-next-step

func New

func New() (NitricClient, error)

New - constructs a new NitricClient with a connection to the nitric service. connection information is retrieved from the standard environment variable