dda

Documentation

Overview

Package dda provides a ready-to-use Data Distribution Agent (DDA).

Index

• type Dda
  • func New(cfg *config.Config) (*Dda, error)
  • func (d *Dda) Close()
  • func (d *Dda) Identity() config.Identity
  • func (d *Dda) Open(timeout time.Duration) error

Types

type Dda

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

Dda represents a Data Distribution Agent with peripheral services and public client APIs. It must be created with New() to ensure that all services and APIs are correctly initialized.

func New

func New(cfg *config.Config) (*Dda, error)

New creates a *Dda structure with DDA services and APIs initialized from the given configuration. An error is returned if the given configuration is invalid or if one of the DDA services or APIs cannot be initialized.

To start the initialized DDA services and APIs invoke Open on the returned *Dda structure.

func (*Dda) Close

func (d *Dda) Close()

Close synchronously shuts down all configured DDA services and APIs gracefully and releases associated resources.

func (*Dda) Identity

func (d *Dda) Identity() config.Identity

Identity gets the Identity of the DDA.

func (*Dda) Open

func (d *Dda) Open(timeout time.Duration) error

Open starts all configured DDA services and APIs and blocks waiting for them to be ready for use. An error is returned if some DDA services or APIs cannot be started, or if the given timeout elapses before setup of a single service or API completes. Specify a zero timeout to disable preliminary timeout behavior.