node

Documentation

Index

• func NewServer(service Service, address string, contextPool context.Pool, opts Options) ns.NetworkService
• type NewTChanChannelFn
• type NewTChanNodeServerFn
• type Options
  • func NewOptions(chanOpts *tchannel.ChannelOptions) Options
• type Service
  • func NewService(db storage.Database, opts tchannelthrift.Options) Service

Functions

func NewServer

func NewServer(
	service Service,
	address string,
	contextPool context.Pool,
	opts Options,
) ns.NetworkService

NewServer creates a new node TChannel Thrift network service

Types

type NewTChanChannelFn

type NewTChanChannelFn func(
	service Service,
	channelName string,
	opts *tchannel.ChannelOptions,
) (*tchannel.Channel, error)

NewTChanChannelFn creates a tchan channel.

type NewTChanNodeServerFn

type NewTChanNodeServerFn func(
	service Service,
	iOpts instrument.Options,
) thrift.TChanServer

NewTChanNodeServerFn creates a tchan node server.

type Options

type Options interface {
	// SetChannelOptions sets a tchan channel options.
	SetChannelOptions(value *tchannel.ChannelOptions) Options

	// ChannelOptions returns the tchan channel options.
	ChannelOptions() *tchannel.ChannelOptions

	// SetTChanChannelFn sets a tchan node channel registration.
	SetTChanChannelFn(value NewTChanChannelFn) Options

	// TChanChannelFn returns a tchan node channel registration.
	TChanChannelFn() NewTChanChannelFn

	// SetTChanNodeServerFn sets a tchan node server builder.
	SetTChanNodeServerFn(value NewTChanNodeServerFn) Options

	// TChanNodeServerFn returns a tchan node server builder.
	TChanNodeServerFn() NewTChanNodeServerFn

	// SetInstrumentOptions sets the instrumentation options.
	SetInstrumentOptions(value instrument.Options) Options

	// InstrumentOptions returns the instrumentation options.
	InstrumentOptions() instrument.Options
}

Options are thrift options.

func NewOptions

func NewOptions(chanOpts *tchannel.ChannelOptions) Options

NewOptions creates a new options.

type Service

type Service interface {
	rpc.TChanNode

	// Only safe to be called one time once the service has started.
	SetDatabase(db storage.Database) error

	// Database returns the current database.
	Database() (storage.Database, error)

	// SetMetadata sets a metadata key to the given value.
	SetMetadata(key, value string)

	// Metadata returns the metadata for the given key and a bool indicating
	// if it is present.
	Metadata(key string) (string, bool)
}

Service is the interface for the node RPC service.

func NewService

func NewService(db storage.Database, opts tchannelthrift.Options) Service

NewService creates a new node TChannel Thrift service