subscription

Documentation

Index

• type Client
  • func NewClient(conn *grpc.ClientConn) Client
• type Payload
  • func (p *Payload) GetProtoValue() ([]byte, error)
• type Subscription

Types

type Client

type Client interface {
	io.Closer

	// Add adds a subscription
	Add(ctx context.Context, subscription *subapi.Subscription) error

	// Remove removes a subscription
	Remove(ctx context.Context, subscription *subapi.Subscription) error

	// Get returns a subscription based on a given subscription ID
	Get(ctx context.Context, id subapi.ID) (*subapi.Subscription, error)

	// List returns the list of existing subscriptions
	List(ctx context.Context) ([]subapi.Subscription, error)

	// Watch watches the subscription changes
	Watch(ctx context.Context, ch chan<- subapi.Event) error
}

Client is an E2 subscription service client interface

func NewClient

func NewClient(conn *grpc.ClientConn) Client

NewClient creates a new subscribe service client

type Payload

type Payload struct {
	Value interface{}
}

Payload is an E2 subscription payload

func (*Payload) GetProtoValue

func (p *Payload) GetProtoValue() ([]byte, error)

GetProtoValue

type Subscription

type Subscription struct {
	// EncodingType payload encoding type
	EncodingType encoding.Type
	// NodeID is the E2 node identifier
	NodeID node.ID
	// ServiceModel is the service model
	ServiceModel sm.ServiceModel
	// Payload is the subscription payload
	Payload Payload
}

Subscription is an E2 subscription