rpc

package
v0.5.6 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 14, 2023 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	Status_name = map[int32]string{
		0: "OK",
		1: "DONE",
		2: "HELD",
	}
	Status_value = map[string]int32{
		"OK":   0,
		"DONE": 1,
		"HELD": 2,
	}
)

Enum value maps for Status.

View Source 
var (
	ListRequest_Filter_Status_name = map[int32]string{
		0: "ALL",
		1: "DONE",
		2: "PENDING",
	}
	ListRequest_Filter_Status_value = map[string]int32{
		"ALL":     0,
		"DONE":    1,
		"PENDING": 2,
	}
)

Enum value maps for ListRequest_Filter_Status.

View Source 
var File_rpc_accord_proto protoreflect.FileDescriptor
View Source 
var V1_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "blacksquaremedia.accord.V1",
	HandlerType: (*V1Server)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Acquire",
			Handler:    _V1_Acquire_Handler,
		},
		{
			MethodName: "Renew",
			Handler:    _V1_Renew_Handler,
		},
		{
			MethodName: "Done",
			Handler:    _V1_Done_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "List",
			Handler:       _V1_List_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "rpc/accord.proto",
}

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

Functions

func RegisterV1Server 

func RegisterV1Server(s grpc.ServiceRegistrar, srv V1Server)

Types

type AcquireRequest 

type AcquireRequest struct {

	// Owner identifier
	Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner,omitempty"`
	// Resource name/identifier.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Custom namespace.
	Namespace string `protobuf:"bytes,3,opt,name=namespace,proto3" json:"namespace,omitempty"`
	// TTL the maximum life-span of the acquired resource (in seconds).
	Ttl uint32 `protobuf:"varint,4,opt,name=ttl,proto3" json:"ttl,omitempty"`
	// Custom, optional metadata.
	Metadata map[string]string `` /* 157-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*AcquireRequest) Descriptor deprecated 

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

Deprecated: Use AcquireRequest.ProtoReflect.Descriptor instead.

func (*AcquireRequest) GetMetadata 

func (x *AcquireRequest) GetMetadata() map[string]string

func (*AcquireRequest) GetName 

func (x *AcquireRequest) GetName() string

func (*AcquireRequest) GetNamespace 

func (x *AcquireRequest) GetNamespace() string

func (*AcquireRequest) GetOwner 

func (x *AcquireRequest) GetOwner() string

func (*AcquireRequest) GetTtl 

func (x *AcquireRequest) GetTtl() uint32

func (*AcquireRequest) ProtoMessage 

func (*AcquireRequest) ProtoMessage()

func (*AcquireRequest) ProtoReflect added in v0.5.1 

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

func (*AcquireRequest) Reset 

func (x *AcquireRequest) Reset()

func (*AcquireRequest) String 

func (x *AcquireRequest) String() string

type AcquireResponse 

type AcquireResponse struct {
	Status Status  `protobuf:"varint,1,opt,name=status,proto3,enum=blacksquaremedia.accord.Status" json:"status,omitempty"`
	Handle *Handle `protobuf:"bytes,2,opt,name=handle,proto3" json:"handle,omitempty"`
	// contains filtered or unexported fields
}

func (*AcquireResponse) Descriptor deprecated 

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

Deprecated: Use AcquireResponse.ProtoReflect.Descriptor instead.

func (*AcquireResponse) GetHandle 

func (x *AcquireResponse) GetHandle() *Handle

func (*AcquireResponse) GetStatus 

func (x *AcquireResponse) GetStatus() Status

func (*AcquireResponse) ProtoMessage 

func (*AcquireResponse) ProtoMessage()

func (*AcquireResponse) ProtoReflect added in v0.5.1 

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

func (*AcquireResponse) Reset 

func (x *AcquireResponse) Reset()

func (*AcquireResponse) String 

func (x *AcquireResponse) String() string

type DoneRequest 

type DoneRequest struct {

	// Owner identifier.
	Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner,omitempty"`
	// Handle identifier.
	HandleId []byte `protobuf:"bytes,2,opt,name=handle_id,json=handleId,proto3" json:"handle_id,omitempty"`
	// Optional metadata.
	Metadata map[string]string `` /* 157-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*DoneRequest) Descriptor deprecated 

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

Deprecated: Use DoneRequest.ProtoReflect.Descriptor instead.

func (*DoneRequest) GetHandleId 

func (x *DoneRequest) GetHandleId() []byte

func (*DoneRequest) GetMetadata 

func (x *DoneRequest) GetMetadata() map[string]string

func (*DoneRequest) GetOwner 

func (x *DoneRequest) GetOwner() string

func (*DoneRequest) ProtoMessage 

func (*DoneRequest) ProtoMessage()

func (*DoneRequest) ProtoReflect added in v0.5.1 

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

func (*DoneRequest) Reset 

func (x *DoneRequest) Reset()

func (*DoneRequest) String 

func (x *DoneRequest) String() string

type DoneResponse 

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

func (*DoneResponse) Descriptor deprecated 

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

Deprecated: Use DoneResponse.ProtoReflect.Descriptor instead.

func (*DoneResponse) ProtoMessage 

func (*DoneResponse) ProtoMessage()

func (*DoneResponse) ProtoReflect added in v0.5.1 

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

func (*DoneResponse) Reset 

func (x *DoneResponse) Reset()

func (*DoneResponse) String 

func (x *DoneResponse) String() string

type Handle 

type Handle struct {

	// Handle ID
	Id []byte `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Resource name/identifier, unique within namespace.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Custom namespace.
	Namespace string `protobuf:"bytes,3,opt,name=namespace,proto3" json:"namespace,omitempty"`
	// Expiration UNIX timestamp (millisecond precision)
	ExpTms int64 `protobuf:"varint,4,opt,name=exp_tms,json=expTms,proto3" json:"exp_tms,omitempty"`
	// Done at UNIX timestamp (millisecond precision)
	DoneTms int64 `protobuf:"varint,5,opt,name=done_tms,json=doneTms,proto3" json:"done_tms,omitempty"`
	// Describes the number of times this handle has been acquired.
	NumAcquired uint32 `protobuf:"varint,6,opt,name=num_acquired,json=numAcquired,proto3" json:"num_acquired,omitempty"`
	// Metadata.
	Metadata map[string]string `` /* 157-byte string literal not displayed */
	// contains filtered or unexported fields
}

Handle

func (*Handle) Descriptor deprecated 

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

Deprecated: Use Handle.ProtoReflect.Descriptor instead.

func (*Handle) DoneTime 

func (h *Handle) DoneTime() time.Time

DoneTime converts DoneTms to time.Time.

func (*Handle) ExpTime 

func (h *Handle) ExpTime() time.Time

ExpTime converts ExpTms to time.Time.

func (*Handle) GetDoneTms added in v0.4.1 

func (x *Handle) GetDoneTms() int64

func (*Handle) GetExpTms added in v0.4.1 

func (x *Handle) GetExpTms() int64

func (*Handle) GetId 

func (x *Handle) GetId() []byte

func (*Handle) GetMetadata 

func (x *Handle) GetMetadata() map[string]string

func (*Handle) GetName 

func (x *Handle) GetName() string

func (*Handle) GetNamespace 

func (x *Handle) GetNamespace() string

func (*Handle) GetNumAcquired 

func (x *Handle) GetNumAcquired() uint32

func (*Handle) IsDone added in v0.4.1 

func (h *Handle) IsDone() bool

IsDone returns true if resource is marked as done.

func (*Handle) ProtoMessage 

func (*Handle) ProtoMessage()

func (*Handle) ProtoReflect added in v0.5.1 

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

func (*Handle) Reset 

func (x *Handle) Reset()

func (*Handle) String 

func (x *Handle) String() string

type HealthCheck added in v0.4.3 

type HealthCheck interface {
	Stop()
}

HealthCheck instances can be stopped.

func RunHealthCheck added in v0.4.3 

func RunHealthCheck(s *grpc.Server, c Pinger, name string, interval time.Duration) HealthCheck

RunHealthCheck starts a standard grpc health check.

type ListRequest 

type ListRequest struct {

	// Filter object.
	Filter *ListRequest_Filter `protobuf:"bytes,1,opt,name=filter,proto3" json:"filter,omitempty"`
	// Skip the first N records.
	Offset uint64 `protobuf:"varint,2,opt,name=offset,proto3" json:"offset,omitempty"`
	// contains filtered or unexported fields
}

func (*ListRequest) Descriptor deprecated 

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

Deprecated: Use ListRequest.ProtoReflect.Descriptor instead.

func (*ListRequest) GetFilter 

func (x *ListRequest) GetFilter() *ListRequest_Filter

func (*ListRequest) GetOffset added in v0.3.3 

func (x *ListRequest) GetOffset() uint64

func (*ListRequest) ProtoMessage 

func (*ListRequest) ProtoMessage()

func (*ListRequest) ProtoReflect added in v0.5.1 

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

func (*ListRequest) Reset 

func (x *ListRequest) Reset()

func (*ListRequest) String 

func (x *ListRequest) String() string

type ListRequest_Filter 

type ListRequest_Filter struct {

	// Namespace prefix.
	Prefix string `protobuf:"bytes,1,opt,name=prefix,proto3" json:"prefix,omitempty"`
	// Only certain status.
	Status ListRequest_Filter_Status `protobuf:"varint,2,opt,name=status,proto3,enum=blacksquaremedia.accord.ListRequest_Filter_Status" json:"status,omitempty"`
	// Filter by metadata.
	Metadata map[string]string `` /* 157-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*ListRequest_Filter) Descriptor deprecated 

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

Deprecated: Use ListRequest_Filter.ProtoReflect.Descriptor instead.

func (*ListRequest_Filter) GetMetadata 

func (x *ListRequest_Filter) GetMetadata() map[string]string

func (*ListRequest_Filter) GetPrefix 

func (x *ListRequest_Filter) GetPrefix() string

func (*ListRequest_Filter) GetStatus 

func (x *ListRequest_Filter) GetStatus() ListRequest_Filter_Status

func (*ListRequest_Filter) ProtoMessage 

func (*ListRequest_Filter) ProtoMessage()

func (*ListRequest_Filter) ProtoReflect added in v0.5.1 

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

func (*ListRequest_Filter) Reset 

func (x *ListRequest_Filter) Reset()

func (*ListRequest_Filter) String 

func (x *ListRequest_Filter) String() string

type ListRequest_Filter_Status 

type ListRequest_Filter_Status int32
const (
	ListRequest_Filter_ALL     ListRequest_Filter_Status = 0
	ListRequest_Filter_DONE    ListRequest_Filter_Status = 1
	ListRequest_Filter_PENDING ListRequest_Filter_Status = 2
)

func (ListRequest_Filter_Status) Descriptor added in v0.5.1 

func (ListRequest_Filter_Status) Descriptor() protoreflect.EnumDescriptor

func (ListRequest_Filter_Status) Enum added in v0.5.1 

func (x ListRequest_Filter_Status) Enum() *ListRequest_Filter_Status

func (ListRequest_Filter_Status) EnumDescriptor deprecated 

func (ListRequest_Filter_Status) EnumDescriptor() ([]byte, []int)

Deprecated: Use ListRequest_Filter_Status.Descriptor instead.

func (ListRequest_Filter_Status) Number added in v0.5.1 

func (x ListRequest_Filter_Status) Number() protoreflect.EnumNumber

func (ListRequest_Filter_Status) String 

func (x ListRequest_Filter_Status) String() string

func (ListRequest_Filter_Status) Type added in v0.5.1 

func (ListRequest_Filter_Status) Type() protoreflect.EnumType

type Pinger added in v0.4.3 

type Pinger interface {
	Ping() error
}

Pinger servers can handle ping requests.

type RenewRequest 

type RenewRequest struct {

	// Owner identifier.
	Owner string `protobuf:"bytes,1,opt,name=owner,proto3" json:"owner,omitempty"`
	// Handle identifier.
	HandleId []byte `protobuf:"bytes,2,opt,name=handle_id,json=handleId,proto3" json:"handle_id,omitempty"`
	// TTL the maximum life-span of the acquired resource (in seconds).
	Ttl uint32 `protobuf:"varint,3,opt,name=ttl,proto3" json:"ttl,omitempty"`
	// Optional metadata.
	Metadata map[string]string `` /* 157-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*RenewRequest) Descriptor deprecated 

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

Deprecated: Use RenewRequest.ProtoReflect.Descriptor instead.

func (*RenewRequest) GetHandleId 

func (x *RenewRequest) GetHandleId() []byte

func (*RenewRequest) GetMetadata 

func (x *RenewRequest) GetMetadata() map[string]string

func (*RenewRequest) GetOwner 

func (x *RenewRequest) GetOwner() string

func (*RenewRequest) GetTtl 

func (x *RenewRequest) GetTtl() uint32

func (*RenewRequest) ProtoMessage 

func (*RenewRequest) ProtoMessage()

func (*RenewRequest) ProtoReflect added in v0.5.1 

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

func (*RenewRequest) Reset 

func (x *RenewRequest) Reset()

func (*RenewRequest) String 

func (x *RenewRequest) String() string

type RenewResponse 

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

func (*RenewResponse) Descriptor deprecated 

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

Deprecated: Use RenewResponse.ProtoReflect.Descriptor instead.

func (*RenewResponse) ProtoMessage 

func (*RenewResponse) ProtoMessage()

func (*RenewResponse) ProtoReflect added in v0.5.1 

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

func (*RenewResponse) Reset 

func (x *RenewResponse) Reset()

func (*RenewResponse) String 

func (x *RenewResponse) String() string

type Status 

type Status int32
const (
	Status_OK   Status = 0 // resource is OK
	Status_DONE Status = 1 // resource is marked as done
	Status_HELD Status = 2 // resource is currently held
)

func (Status) Descriptor added in v0.5.1 

func (Status) Descriptor() protoreflect.EnumDescriptor

func (Status) Enum added in v0.5.1 

func (x Status) Enum() *Status

func (Status) EnumDescriptor deprecated 

func (Status) EnumDescriptor() ([]byte, []int)

Deprecated: Use Status.Descriptor instead.

func (Status) Number added in v0.5.1 

func (x Status) Number() protoreflect.EnumNumber

func (Status) String 

func (x Status) String() string

func (Status) Type added in v0.5.1 

func (Status) Type() protoreflect.EnumType

type UnimplementedV1Server 

type UnimplementedV1Server struct {
}

UnimplementedV1Server must be embedded to have forward compatible implementations.

func (UnimplementedV1Server) Acquire 

func (UnimplementedV1Server) Acquire(context.Context, *AcquireRequest) (*AcquireResponse, error)

func (UnimplementedV1Server) Done 

func (UnimplementedV1Server) Done(context.Context, *DoneRequest) (*DoneResponse, error)

func (UnimplementedV1Server) List 

func (UnimplementedV1Server) List(*ListRequest, V1_ListServer) error

func (UnimplementedV1Server) Renew 

func (UnimplementedV1Server) Renew(context.Context, *RenewRequest) (*RenewResponse, error)

type UnsafeV1Server added in v0.5.3 

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

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

type V1Client 

type V1Client interface {
	// Acquire requests resource handle.
	Acquire(ctx context.Context, in *AcquireRequest, opts ...grpc.CallOption) (*AcquireResponse, error)
	// Renew renews resource handle.
	Renew(ctx context.Context, in *RenewRequest, opts ...grpc.CallOption) (*RenewResponse, error)
	// Done marks an handle as completed.
	Done(ctx context.Context, in *DoneRequest, opts ...grpc.CallOption) (*DoneResponse, error)
	// List streams handles that are done.
	List(ctx context.Context, in *ListRequest, opts ...grpc.CallOption) (V1_ListClient, error)
}

V1Client is the client API for V1 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 NewV1Client 

func NewV1Client(cc grpc.ClientConnInterface) V1Client

type V1Server 

type V1Server interface {
	// Acquire requests resource handle.
	Acquire(context.Context, *AcquireRequest) (*AcquireResponse, error)
	// Renew renews resource handle.
	Renew(context.Context, *RenewRequest) (*RenewResponse, error)
	// Done marks an handle as completed.
	Done(context.Context, *DoneRequest) (*DoneResponse, error)
	// List streams handles that are done.
	List(*ListRequest, V1_ListServer) error
	// contains filtered or unexported methods
}

V1Server is the server API for V1 service. All implementations must embed UnimplementedV1Server for forward compatibility

type V1_ListClient 

type V1_ListClient interface {
	Recv() (*Handle, error)
	grpc.ClientStream
}

type V1_ListServer 

type V1_ListServer interface {
	Send(*Handle) error
	grpc.ServerStream
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.