conn

README

Package conn

conn and its subpackages conn/http and conn/storage provide all calls needed for the ARN service.

This package is a little non-standard. Normally when I make a conn package it encapsulates all the calls to a service.

In this case, conn uses the models.Notification.SendEvent() method to send events to the ARN service. This allows us to let the specific model's notifications package handle changes to the event data as required if the data size gets too large. This is a consequence of ARN being backed by Kusto which cannot handle large batches of data without going to blob storage.

conn/http is a wrapper around azcore.Client which is a wrapper around http.Client. This simply encapsulates the client endpoing and request specifics for the ARN service.

conn/storage is a wrapper around azblob. This encapsulates the specifics of the ARN blob storage container.

Documentation

Overview

Package conn provides the top level package for all connection types to the ARN service.

Index

• Variables
• type Option
  • func WithLogger(log *slog.Logger) Option
• type Service
  • func New(httpClient *http.Client, store *storage.Client, clientErrs chan error, ...) (*Service, error)
  • func (r *Service) Close() error
  • func (s *Service) Send(notify models.Notifications)

Variables

var PromisePool = sync.Pool{
	New: func() any {
		return make(chan error, 1)
	},
}

PromisePool is a pool of promises to use for notifications.

Types

type Option

type Option func(*Service) error

func WithLogger

func WithLogger(log *slog.Logger) Option

WithLogger sets the logger on the client. By default it uses slog.Default().

type Service

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

Reset provides a REST connection to the ARN service.

func New

func New(httpClient *http.Client, store *storage.Client, clientErrs chan error, options ...Option) (*Service, error)

New creates a new connection to the ARN service.

func (*Service) Close

func (r *Service) Close() error

Close closes the connection to the ARN service.

func (*Service) Send

func (s *Service) Send(notify models.Notifications)

Send sends a notification to the ARN service. This will block if the internal channel is full. notify.DataCount() must indicate no more than 1000 items. Not thread safe.