protobuf

README

Athena Protocol Buffers

Athena uses Protocol Buffers to define the structure of communication between all Microservices.

What are Protocol Buffers?

Protobuf (short for Protocol Buffer) is a library for serializing and deserializing data. It's a language agnostic library used for standardizing communication between Microservices.

How are they used within Athena

Athena uses auto-generated Protocol Buffer Go code to communicate between Microservices.

Documentation

Index

• Variables
• func RegisterUserServer(s grpc.ServiceRegistrar, srv UserServer)
• type PingRequest
  • func (*PingRequest) Descriptor() ([]byte, []int)
  • func (x *PingRequest) GetMessage() string
  • func (*PingRequest) ProtoMessage()
  • func (x *PingRequest) ProtoReflect() protoreflect.Message
  • func (x *PingRequest) Reset()
  • func (x *PingRequest) String() string
• type PingResponse
  • func (*PingResponse) Descriptor() ([]byte, []int)
  • func (x *PingResponse) GetMessage() string
  • func (*PingResponse) ProtoMessage()
  • func (x *PingResponse) ProtoReflect() protoreflect.Message
  • func (x *PingResponse) Reset()
  • func (x *PingResponse) String() string
• type UnimplementedUserServer
  • func (UnimplementedUserServer) Ping(context.Context, *PingRequest) (*PingResponse, error)
• type UnsafeUserServer
• type UserClient
  • func NewUserClient(cc grpc.ClientConnInterface) UserClient
• type UserServer

Variables

var File_user_proto protoreflect.FileDescriptor

var User_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "User",
	HandlerType: (*UserServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Ping",
			Handler:    _User_Ping_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "user.proto",
}

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

Functions

func RegisterUserServer

func RegisterUserServer(s grpc.ServiceRegistrar, srv UserServer)

Types

type PingRequest

type PingRequest struct {
	Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

func (*PingRequest) Descriptor

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

Deprecated: Use PingRequest.ProtoReflect.Descriptor instead.

func (*PingRequest) GetMessage

func (x *PingRequest) GetMessage() string

func (*PingRequest) ProtoMessage

func (*PingRequest) ProtoMessage()

func (*PingRequest) ProtoReflect

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

func (*PingRequest) Reset

func (x *PingRequest) Reset()

func (*PingRequest) String

func (x *PingRequest) String() string

type PingResponse

type PingResponse struct {
	Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

func (*PingResponse) Descriptor

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

Deprecated: Use PingResponse.ProtoReflect.Descriptor instead.

func (*PingResponse) GetMessage

func (x *PingResponse) GetMessage() string

func (*PingResponse) ProtoMessage

func (*PingResponse) ProtoMessage()

func (*PingResponse) ProtoReflect

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

func (*PingResponse) Reset

func (x *PingResponse) Reset()

func (*PingResponse) String

func (x *PingResponse) String() string

type UnimplementedUserServer

type UnimplementedUserServer struct {
}

UnimplementedUserServer must be embedded to have forward compatible implementations.

func (UnimplementedUserServer) Ping

func (UnimplementedUserServer) Ping(context.Context, *PingRequest) (*PingResponse, error)

type UnsafeUserServer

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

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

type UserClient

type UserClient interface {
	Ping(ctx context.Context, in *PingRequest, opts ...grpc.CallOption) (*PingResponse, error)
}

UserClient is the client API for User 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 NewUserClient

func NewUserClient(cc grpc.ClientConnInterface) UserClient

type UserServer

type UserServer interface {
	Ping(context.Context, *PingRequest) (*PingResponse, error)
	// contains filtered or unexported methods
}

UserServer is the server API for User service. All implementations must embed UnimplementedUserServer for forward compatibility