Ydb_Coordination_V1

Documentation

Index

• Constants
• Variables
• func RegisterCoordinationServiceServer(s grpc.ServiceRegistrar, srv CoordinationServiceServer)
• type CoordinationServiceClient
  • func NewCoordinationServiceClient(cc grpc.ClientConnInterface) CoordinationServiceClient
• type CoordinationServiceServer
• type CoordinationService_SessionClient
• type CoordinationService_SessionServer
• type UnimplementedCoordinationServiceServer
  • func (UnimplementedCoordinationServiceServer) AlterNode(context.Context, *Ydb_Coordination.AlterNodeRequest) (*Ydb_Coordination.AlterNodeResponse, error)
  • func (UnimplementedCoordinationServiceServer) CreateNode(context.Context, *Ydb_Coordination.CreateNodeRequest) (*Ydb_Coordination.CreateNodeResponse, error)
  • func (UnimplementedCoordinationServiceServer) DescribeNode(context.Context, *Ydb_Coordination.DescribeNodeRequest) (*Ydb_Coordination.DescribeNodeResponse, error)
  • func (UnimplementedCoordinationServiceServer) DropNode(context.Context, *Ydb_Coordination.DropNodeRequest) (*Ydb_Coordination.DropNodeResponse, error)
  • func (UnimplementedCoordinationServiceServer) Session(CoordinationService_SessionServer) error
• type UnsafeCoordinationServiceServer

Constants

const (
	CoordinationService_Session_FullMethodName      = "/Ydb.Coordination.V1.CoordinationService/Session"
	CoordinationService_CreateNode_FullMethodName   = "/Ydb.Coordination.V1.CoordinationService/CreateNode"
	CoordinationService_AlterNode_FullMethodName    = "/Ydb.Coordination.V1.CoordinationService/AlterNode"
	CoordinationService_DropNode_FullMethodName     = "/Ydb.Coordination.V1.CoordinationService/DropNode"
	CoordinationService_DescribeNode_FullMethodName = "/Ydb.Coordination.V1.CoordinationService/DescribeNode"
)

Variables

var CoordinationService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "Ydb.Coordination.V1.CoordinationService",
	HandlerType: (*CoordinationServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CreateNode",
			Handler:    _CoordinationService_CreateNode_Handler,
		},
		{
			MethodName: "AlterNode",
			Handler:    _CoordinationService_AlterNode_Handler,
		},
		{
			MethodName: "DropNode",
			Handler:    _CoordinationService_DropNode_Handler,
		},
		{
			MethodName: "DescribeNode",
			Handler:    _CoordinationService_DescribeNode_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "Session",
			Handler:       _CoordinationService_Session_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
	},
	Metadata: "ydb_coordination_v1.proto",
}

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

var File_ydb_coordination_v1_proto protoreflect.FileDescriptor

Functions

func RegisterCoordinationServiceServer

func RegisterCoordinationServiceServer(s grpc.ServiceRegistrar, srv CoordinationServiceServer)

Types

type CoordinationServiceClient

type CoordinationServiceClient interface {
	// *
	// Bidirectional stream used to establish a session with a coordination node
	//
	// Relevant APIs for managing semaphores, distributed locking, creating or
	// restoring a previously established session are described using nested
	// messages in SessionRequest and SessionResponse. Session is established
	// with a specific coordination node (previously created using CreateNode
	// below) and semaphores are local to that coordination node.
	Session(ctx context.Context, opts ...grpc.CallOption) (CoordinationService_SessionClient, error)
	// Creates a new coordination node
	CreateNode(ctx context.Context, in *Ydb_Coordination.CreateNodeRequest, opts ...grpc.CallOption) (*Ydb_Coordination.CreateNodeResponse, error)
	// Modifies settings of a coordination node
	AlterNode(ctx context.Context, in *Ydb_Coordination.AlterNodeRequest, opts ...grpc.CallOption) (*Ydb_Coordination.AlterNodeResponse, error)
	// Drops a coordination node
	DropNode(ctx context.Context, in *Ydb_Coordination.DropNodeRequest, opts ...grpc.CallOption) (*Ydb_Coordination.DropNodeResponse, error)
	// Describes a coordination node
	DescribeNode(ctx context.Context, in *Ydb_Coordination.DescribeNodeRequest, opts ...grpc.CallOption) (*Ydb_Coordination.DescribeNodeResponse, error)
}

CoordinationServiceClient is the client API for CoordinationService 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 NewCoordinationServiceClient

func NewCoordinationServiceClient(cc grpc.ClientConnInterface) CoordinationServiceClient

type CoordinationServiceServer

type CoordinationServiceServer interface {
	// *
	// Bidirectional stream used to establish a session with a coordination node
	//
	// Relevant APIs for managing semaphores, distributed locking, creating or
	// restoring a previously established session are described using nested
	// messages in SessionRequest and SessionResponse. Session is established
	// with a specific coordination node (previously created using CreateNode
	// below) and semaphores are local to that coordination node.
	Session(CoordinationService_SessionServer) error
	// Creates a new coordination node
	CreateNode(context.Context, *Ydb_Coordination.CreateNodeRequest) (*Ydb_Coordination.CreateNodeResponse, error)
	// Modifies settings of a coordination node
	AlterNode(context.Context, *Ydb_Coordination.AlterNodeRequest) (*Ydb_Coordination.AlterNodeResponse, error)
	// Drops a coordination node
	DropNode(context.Context, *Ydb_Coordination.DropNodeRequest) (*Ydb_Coordination.DropNodeResponse, error)
	// Describes a coordination node
	DescribeNode(context.Context, *Ydb_Coordination.DescribeNodeRequest) (*Ydb_Coordination.DescribeNodeResponse, error)
	// contains filtered or unexported methods
}

CoordinationServiceServer is the server API for CoordinationService service. All implementations must embed UnimplementedCoordinationServiceServer for forward compatibility

type CoordinationService_SessionClient

type CoordinationService_SessionClient interface {
	Send(*Ydb_Coordination.SessionRequest) error
	Recv() (*Ydb_Coordination.SessionResponse, error)
	grpc.ClientStream
}

type CoordinationService_SessionServer

type CoordinationService_SessionServer interface {
	Send(*Ydb_Coordination.SessionResponse) error
	Recv() (*Ydb_Coordination.SessionRequest, error)
	grpc.ServerStream
}

type UnimplementedCoordinationServiceServer

type UnimplementedCoordinationServiceServer struct {
}

UnimplementedCoordinationServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedCoordinationServiceServer) AlterNode

func (UnimplementedCoordinationServiceServer) AlterNode(context.Context, *Ydb_Coordination.AlterNodeRequest) (*Ydb_Coordination.AlterNodeResponse, error)

func (UnimplementedCoordinationServiceServer) CreateNode

func (UnimplementedCoordinationServiceServer) CreateNode(context.Context, *Ydb_Coordination.CreateNodeRequest) (*Ydb_Coordination.CreateNodeResponse, error)

func (UnimplementedCoordinationServiceServer) DescribeNode

func (UnimplementedCoordinationServiceServer) DescribeNode(context.Context, *Ydb_Coordination.DescribeNodeRequest) (*Ydb_Coordination.DescribeNodeResponse, error)

func (UnimplementedCoordinationServiceServer) DropNode

func (UnimplementedCoordinationServiceServer) DropNode(context.Context, *Ydb_Coordination.DropNodeRequest) (*Ydb_Coordination.DropNodeResponse, error)

func (UnimplementedCoordinationServiceServer) Session

func (UnimplementedCoordinationServiceServer) Session(CoordinationService_SessionServer) error

type UnsafeCoordinationServiceServer

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

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