subscriptiontask

Documentation

Index

• type Client
  • func NewClient(conn *grpc.ClientConn) Client
• type FilterOption
  • func WithEndpointID(id epapi.ID) FilterOption
  • func WithSubscriptionID(id subapi.ID) FilterOption
• type ListOption
• type WatchOption

Types

type Client

type Client interface {
	io.Closer

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

	// List returns the list of existing subscriptions
	List(ctx context.Context, opts ...ListOption) ([]subtaskapi.SubscriptionTask, error)

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

Client is an E2 subscription service client interface

func NewClient

func NewClient(conn *grpc.ClientConn) Client

NewClient creates a new subscribe task service client

type FilterOption

type FilterOption interface {
	ListOption
	WatchOption
}

FilterOption is an option for filtering List/Watch calls

func WithEndpointID

func WithEndpointID(id epapi.ID) FilterOption

WithEndpointID creates an option for filtering by endpoint ID

func WithSubscriptionID

func WithSubscriptionID(id subapi.ID) FilterOption

WithSubscriptionID creates an option for filtering by subscription ID

type ListOption

type ListOption interface {
	// contains filtered or unexported methods
}

ListOption is an option for filtering List calls

type WatchOption

type WatchOption interface {
	// contains filtered or unexported methods
}

WatchOption is an option for filtering Watch calls