e2

Documentation

Index

• type Client
  • func NewClient(config Config) (Client, error)
• type Config
• type ServiceConfig
  • func (c ServiceConfig) GetHost() string
  • func (c ServiceConfig) GetPort() int

Types

type Client

type Client interface {
	// Subscribe creates a subscription from the given SubscriptionDetails
	// The Subscribe method will block until the subscription is successfully registered.
	// The context.Context represents the lifecycle of this initial subscription process.
	// Once the subscription has been created and the method returns, indications will be written
	// to the given channel.
	// If the subscription is successful, a subscription.Context will be returned. The subscription
	// context can be used to cancel the subscription by calling Close() on the subscription.Context.
	Subscribe(ctx context.Context, details subapi.SubscriptionDetails, ch chan<- indication.Indication) (subscription.Context, error)
}

Client is an E2 client

func NewClient

func NewClient(config Config) (Client, error)

NewClient creates a new E2 client

type Config

type Config struct {
	// AppID is the application identifier
	AppID app.ID
	// InstanceID is the application instance identifier
	InstanceID app.InstanceID
	// SubscriptionService is the subscription service configuration
	SubscriptionService ServiceConfig
}

Config is an E2 client configuration

type ServiceConfig

type ServiceConfig struct {
	// Host is the service host
	Host string
	// Port is the service port
	Port int
}

ServiceConfig is an E2 service configuration

func (ServiceConfig) GetHost

func (c ServiceConfig) GetHost() string

GetHost gets the service host

func (ServiceConfig) GetPort

func (c ServiceConfig) GetPort() int

GetPort gets the service port