vakeel_way

Documentation

Index

• Constants
• Variables
• func RegisterStateServiceServer(s grpc.ServiceRegistrar, srv StateServiceServer)
• type StateServiceClient
  • func NewStateServiceClient(cc grpc.ClientConnInterface) StateServiceClient
• type StateServiceServer
• type StateService_UpdateClient
• type StateService_UpdateServer
• type UnimplementedStateServiceServer
  • func (UnimplementedStateServiceServer) Update(StateService_UpdateServer) error
• type UnsafeStateServiceServer
• type UpdateRequest
  • func (*UpdateRequest) Descriptor() ([]byte, []int)
  • func (x *UpdateRequest) GetIds() []*v1.UUID
  • func (*UpdateRequest) ProtoMessage()
  • func (x *UpdateRequest) ProtoReflect() protoreflect.Message
  • func (x *UpdateRequest) Reset()
  • func (x *UpdateRequest) String() string
• type UpdateResponse
  • func (*UpdateResponse) Descriptor() ([]byte, []int)
  • func (*UpdateResponse) ProtoMessage()
  • func (x *UpdateResponse) ProtoReflect() protoreflect.Message
  • func (x *UpdateResponse) Reset()
  • func (x *UpdateResponse) String() string

Constants

const (
	StateService_Update_FullMethodName = "/vakeel_way.StateService/Update"
)

Variables

var File_api_vakeel_way_state_proto protoreflect.FileDescriptor

var StateService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "vakeel_way.StateService",
	HandlerType: (*StateServiceServer)(nil),
	Methods:     []grpc.MethodDesc{},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "Update",
			Handler:       _StateService_Update_Handler,
			ClientStreams: true,
		},
	},
	Metadata: "api/vakeel_way/state.proto",
}

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

Functions

func RegisterStateServiceServer

func RegisterStateServiceServer(s grpc.ServiceRegistrar, srv StateServiceServer)

Types

type StateServiceClient

type StateServiceClient interface {
	// Updates the list of UUIDs.
	//
	// Takes an array of IDs as input and marks these services as working for
	// some time. If services stop sending information about themselves, then they
	// do not work and it is necessary to notify monitoring and create an
	// incident.
	//
	// The input is a stream of UpdateRequest messages. Each UpdateRequest
	// message contains a list of UUIDs that need to be updated.
	//
	// The output is a single UpdateResponse message. The UpdateResponse message
	// is an empty message that indicates that the update operation was
	// successful.
	Update(ctx context.Context, opts ...grpc.CallOption) (StateService_UpdateClient, error)
}

StateServiceClient is the client API for StateService 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.

StateService is a gRPC service that allows clients to update a list of UUIDs.

The service provides the ability to update a list of UUIDs. The list of UUIDs is sent as a stream of UpdateRequest messages. Each UpdateRequest message contains a list of UUIDs that need to be updated. These UUIDs are used to uniquely identify the request and can be used to track the request throughout the system.

The service is used to test that the gRPC service is working correctly. This is done by sending a stream of UpdateRequest messages and receiving a single UpdateResponse message in return. The UpdateResponse message is an empty message that indicates that the update operation was successful.

It is also used to mark services as working for some time. If services stop sending information about themselves, then they do not work and it is necessary to notify monitoring and create an incident.

func NewStateServiceClient

func NewStateServiceClient(cc grpc.ClientConnInterface) StateServiceClient

type StateServiceServer

type StateServiceServer interface {
	// Updates the list of UUIDs.
	//
	// Takes an array of IDs as input and marks these services as working for
	// some time. If services stop sending information about themselves, then they
	// do not work and it is necessary to notify monitoring and create an
	// incident.
	//
	// The input is a stream of UpdateRequest messages. Each UpdateRequest
	// message contains a list of UUIDs that need to be updated.
	//
	// The output is a single UpdateResponse message. The UpdateResponse message
	// is an empty message that indicates that the update operation was
	// successful.
	Update(StateService_UpdateServer) error
	// contains filtered or unexported methods
}

StateServiceServer is the server API for StateService service. All implementations must embed UnimplementedStateServiceServer for forward compatibility

StateService is a gRPC service that allows clients to update a list of UUIDs.

The service provides the ability to update a list of UUIDs. The list of UUIDs is sent as a stream of UpdateRequest messages. Each UpdateRequest message contains a list of UUIDs that need to be updated. These UUIDs are used to uniquely identify the request and can be used to track the request throughout the system.

The service is used to test that the gRPC service is working correctly. This is done by sending a stream of UpdateRequest messages and receiving a single UpdateResponse message in return. The UpdateResponse message is an empty message that indicates that the update operation was successful.

It is also used to mark services as working for some time. If services stop sending information about themselves, then they do not work and it is necessary to notify monitoring and create an incident.

type StateService_UpdateClient

type StateService_UpdateClient interface {
	Send(*UpdateRequest) error
	CloseAndRecv() (*UpdateResponse, error)
	grpc.ClientStream
}

type StateService_UpdateServer

type StateService_UpdateServer interface {
	SendAndClose(*UpdateResponse) error
	Recv() (*UpdateRequest, error)
	grpc.ServerStream
}

type UnimplementedStateServiceServer

type UnimplementedStateServiceServer struct {
}

UnimplementedStateServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedStateServiceServer) Update

func (UnimplementedStateServiceServer) Update(StateService_UpdateServer) error

type UnsafeStateServiceServer

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

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

type UpdateRequest

type UpdateRequest struct {

	// The list of UUIDs that need to be updated.
	//
	// This field contains the list of UUIDs that need to be updated. Each UUID is
	// stored in an UUID message.
	Ids []*v1.UUID `protobuf:"bytes,1,rep,name=ids,proto3" json:"ids,omitempty"`
	// contains filtered or unexported fields
}

UpdateRequest is a message that represents a request to update a list of UUIDs.

This message contains a list of UUIDs that need to be updated. These UUIDs are used to uniquely identify the request and can be used to track the request throughout the system.

func (*UpdateRequest) Descriptor

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

Deprecated: Use UpdateRequest.ProtoReflect.Descriptor instead.

func (*UpdateRequest) GetIds

func (x *UpdateRequest) GetIds() []*v1.UUID

func (*UpdateRequest) ProtoMessage

func (*UpdateRequest) ProtoMessage()

func (*UpdateRequest) ProtoReflect

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

func (*UpdateRequest) Reset

func (x *UpdateRequest) Reset()

func (*UpdateRequest) String

func (x *UpdateRequest) String() string

type UpdateResponse

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

UpdateResponse is a message that represents a response to an update request.

This message is an empty message that indicates that the update operation was successful.

func (*UpdateResponse) Descriptor

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

Deprecated: Use UpdateResponse.ProtoReflect.Descriptor instead.

func (*UpdateResponse) ProtoMessage

func (*UpdateResponse) ProtoMessage()

func (*UpdateResponse) ProtoReflect

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

func (*UpdateResponse) Reset

func (x *UpdateResponse) Reset()

func (*UpdateResponse) String

func (x *UpdateResponse) String() string