notify

Documentation

Overview

Package notify implements a event.Notifier client and a ready to use service component.

This package is a work in progress and makes no API stability promises.

Index

• Constants
• func ClientBuilder(opt ...ClientOption) apiservice.BuildFn
• func RegisterServer(server *grpc.Server, service *Service)
• func ServiceName() string
• type Client
  • func NewClient(conn *grpc.ClientConn, opt ...ClientOption) *Client
  • func (c *Client) API() string
  • func (c *Client) Close() error
  • func (c *Client) NotifyEvent(ctx context.Context, e event.Event) (string, error)
  • func (c *Client) Ping() error
• type ClientOption
  • func CloseConnection(b bool) ClientOption
  • func SetLogger(l yalogi.Logger) ClientOption
• type Service
  • func NewService(n event.Notifier, opt ...ServiceOption) *Service
  • func (s *Service) NotifyEvent(ctx context.Context, in *pb.NotifyEventRequest) (*pb.NotifyEventResponse, error)
• type ServiceOption
  • func SetServiceLogger(l yalogi.Logger) ServiceOption

Constants

const (
	APIName    = "luids.event"
	APIVersion = "v1"
	APIService = "Notify"
)

Constants for api description.

Functions

func ClientBuilder

func ClientBuilder(opt ...ClientOption) apiservice.BuildFn

ClientBuilder returns builder function for the apiservice

func RegisterServer

func RegisterServer(server *grpc.Server, service *Service)

RegisterServer registers a service in the grpc server.

func ServiceName

func ServiceName() string

ServiceName returns service name.

Types

type Client

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

Client provides a grpc client.

func NewClient

func NewClient(conn *grpc.ClientConn, opt ...ClientOption) *Client

NewClient returns a new client.

func (*Client) API

func (c *Client) API() string

API returns API service name implemented

func (*Client) Close

func (c *Client) Close() error

Close the client

func (*Client) NotifyEvent

func (c *Client) NotifyEvent(ctx context.Context, e event.Event) (string, error)

NotifyEvent implements event.Notifier interface.

func (*Client) Ping

func (c *Client) Ping() error

Ping checks connectivity with the api

type ClientOption

type ClientOption func(*clientOpts)

ClientOption encapsules options for client.

func CloseConnection

func CloseConnection(b bool) ClientOption

CloseConnection option closes grpc connection on shutdown.

func SetLogger

func SetLogger(l yalogi.Logger) ClientOption

SetLogger option allows set a custom logger.

type Service

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

Service implements a grpc service wrapper.

func NewService

func NewService(n event.Notifier, opt ...ServiceOption) *Service

NewService returns a new Service.

func (*Service) NotifyEvent

func (s *Service) NotifyEvent(ctx context.Context, in *pb.NotifyEventRequest) (*pb.NotifyEventResponse, error)

NotifyEvent implements grpc api.

type ServiceOption

type ServiceOption func(*serviceOpts)

ServiceOption is used for service configuration.

func SetServiceLogger

func SetServiceLogger(l yalogi.Logger) ServiceOption

SetServiceLogger option allows set a custom logger.