named

Documentation

Index

• Variables
• func RegisterNamedServer(s grpc.ServiceRegistrar, srv NamedServer)
• type Config
• type Empty
  • func (*Empty) Descriptor() ([]byte, []int)
  • func (*Empty) ProtoMessage()
  • func (x *Empty) ProtoReflect() protoreflect.Message
  • func (x *Empty) Reset()
  • func (x *Empty) String() string
• type EventConfig
• type Named
  • func New(cfg Config, logger log.Logger, conn *grpc.ClientConn) (*Named, error)
  • func (t *Named) Connect(ctx context.Context) error
  • func (t *Named) Observe(ctx context.Context, req *NamedTimeStamp) (*Empty, error)
  • func (t *Named) Schedule(ctx context.Context, req *NamedTimeStamp) (*Empty, error)
• type NamedClient
  • func NewNamedClient(cc grpc.ClientConnInterface) NamedClient
• type NamedServer
• type NamedTimeStamp
  • func (*NamedTimeStamp) Descriptor() ([]byte, []int)
  • func (x *NamedTimeStamp) GetName() string
  • func (x *NamedTimeStamp) GetTime() *timestamppb.Timestamp
  • func (*NamedTimeStamp) ProtoMessage()
  • func (x *NamedTimeStamp) ProtoReflect() protoreflect.Message
  • func (x *NamedTimeStamp) Reset()
  • func (x *NamedTimeStamp) String() string
• type RepeatEventConfig
• type UnimplementedNamedServer
  • func (UnimplementedNamedServer) Observe(context.Context, *NamedTimeStamp) (*Empty, error)
  • func (UnimplementedNamedServer) Schedule(context.Context, *NamedTimeStamp) (*Empty, error)
• type UnsafeNamedServer

Variables

var File_modules_timer_named_named_proto protoreflect.FileDescriptor

var Named_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "timer.Named",
	HandlerType: (*NamedServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Observe",
			Handler:    _Named_Observe_Handler,
		},
		{
			MethodName: "Schedule",
			Handler:    _Named_Schedule_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "modules/timer/named/named.proto",
}

Named_ServiceDesc is the grpc.ServiceDesc for Named service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterNamedServer

func RegisterNamedServer(s grpc.ServiceRegistrar, srv NamedServer)

Types

type Config

type Config struct {
	TimeZone       string              `yaml:"timezone"`
	ReloadInterval int                 `yaml:"reload_interval"`
	FutureLimit    int                 `yaml:"future_limit"`
	RepeatEvents   []RepeatEventConfig `yaml:"repeat_events"`
	Events         []EventConfig       `yaml:"events"`
}

type Empty

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

func (*Empty) Descriptor

func (*Empty) Descriptor() ([]byte, []int)

Deprecated: Use Empty.ProtoReflect.Descriptor instead.

func (*Empty) ProtoMessage

func (*Empty) ProtoMessage()

func (*Empty) ProtoReflect

func (x *Empty) ProtoReflect() protoreflect.Message

func (*Empty) Reset

func (x *Empty) Reset()

func (*Empty) String

func (x *Empty) String() string

type EventConfig

type EventConfig struct {
	// Produce is the name of the event to emit.
	Produce string   `yaml:"produce"`
	Time    string   `yaml:"time"`
	Days    []string `yaml:"days"`
}

type Named

type Named struct {
	UnimplementedNamedServer
	services.Service
	// contains filtered or unexported fields
}

func New

func New(cfg Config, logger log.Logger, conn *grpc.ClientConn) (*Named, error)

func (*Named) Connect

func (t *Named) Connect(ctx context.Context) error

Connect implements events.Producer

func (*Named) Observe

func (t *Named) Observe(ctx context.Context, req *NamedTimeStamp) (*Empty, error)

func (*Named) Schedule

func (t *Named) Schedule(ctx context.Context, req *NamedTimeStamp) (*Empty, error)

type NamedClient

type NamedClient interface {
	Observe(ctx context.Context, in *NamedTimeStamp, opts ...grpc.CallOption) (*Empty, error)
	Schedule(ctx context.Context, in *NamedTimeStamp, opts ...grpc.CallOption) (*Empty, error)
}

NamedClient is the client API for Named service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewNamedClient

func NewNamedClient(cc grpc.ClientConnInterface) NamedClient

type NamedServer

type NamedServer interface {
	Observe(context.Context, *NamedTimeStamp) (*Empty, error)
	Schedule(context.Context, *NamedTimeStamp) (*Empty, error)
	// contains filtered or unexported methods
}

NamedServer is the server API for Named service. All implementations must embed UnimplementedNamedServer for forward compatibility

type NamedTimeStamp

type NamedTimeStamp struct {
	Name string                 `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	Time *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=time,proto3" json:"time,omitempty"`
	// contains filtered or unexported fields
}

func (*NamedTimeStamp) Descriptor

func (*NamedTimeStamp) Descriptor() ([]byte, []int)

Deprecated: Use NamedTimeStamp.ProtoReflect.Descriptor instead.

func (*NamedTimeStamp) GetName

func (x *NamedTimeStamp) GetName() string

func (*NamedTimeStamp) GetTime

func (x *NamedTimeStamp) GetTime() *timestamppb.Timestamp

func (*NamedTimeStamp) ProtoMessage

func (*NamedTimeStamp) ProtoMessage()

func (*NamedTimeStamp) ProtoReflect

func (x *NamedTimeStamp) ProtoReflect() protoreflect.Message

func (*NamedTimeStamp) Reset

func (x *NamedTimeStamp) Reset()

func (*NamedTimeStamp) String

func (x *NamedTimeStamp) String() string

type RepeatEventConfig

type RepeatEventConfig struct {
	// Produce is the name of the event to emit.
	Produce string `yaml:"produce"`
	Every   struct {
		Seconds int `yaml:"seconds"`
	} `yaml:"every"`
}

type UnimplementedNamedServer

type UnimplementedNamedServer struct {
}

UnimplementedNamedServer must be embedded to have forward compatible implementations.

func (UnimplementedNamedServer) Observe

func (UnimplementedNamedServer) Observe(context.Context, *NamedTimeStamp) (*Empty, error)

func (UnimplementedNamedServer) Schedule

func (UnimplementedNamedServer) Schedule(context.Context, *NamedTimeStamp) (*Empty, error)

type UnsafeNamedServer

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

UnsafeNamedServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to NamedServer will result in compilation errors.