grpc_ping_go

README

grpc-ping-go

A repository containing the ping example protos generated with GPM

Documentation

Index

• Variables
• func RegisterPingServer(s *grpc.Server, srv PingServer)
• type PingClient
  • func NewPingClient(cc grpc.ClientConnInterface) PingClient
• 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
  • func (m *PingRequest) Validate() error
• type PingRequestValidationError
  • func (e PingRequestValidationError) Cause() error
  • func (e PingRequestValidationError) Error() string
  • func (e PingRequestValidationError) ErrorName() string
  • func (e PingRequestValidationError) Field() string
  • func (e PingRequestValidationError) Key() bool
  • func (e PingRequestValidationError) Reason() string
• type PingServer
• type PongResponse
  • func (*PongResponse) Descriptor() ([]byte, []int)
  • func (x *PongResponse) GetMessage() string
  • func (*PongResponse) ProtoMessage()
  • func (x *PongResponse) ProtoReflect() protoreflect.Message
  • func (x *PongResponse) Reset()
  • func (x *PongResponse) String() string
  • func (m *PongResponse) Validate() error
• type PongResponseValidationError
  • func (e PongResponseValidationError) Cause() error
  • func (e PongResponseValidationError) Error() string
  • func (e PongResponseValidationError) ErrorName() string
  • func (e PongResponseValidationError) Field() string
  • func (e PongResponseValidationError) Key() bool
  • func (e PongResponseValidationError) Reason() string
• type UnimplementedPingServer
  • func (*UnimplementedPingServer) Ping(context.Context, *PingRequest) (*PongResponse, error)

Variables

var File_ping_entities_proto protoreflect.FileDescriptor

var File_ping_services_proto protoreflect.FileDescriptor

Functions

func RegisterPingServer

func RegisterPingServer(s *grpc.Server, srv PingServer)

Types

type PingClient

type PingClient interface {
	// Ping sends a ping message
	Ping(ctx context.Context, in *PingRequest, opts ...grpc.CallOption) (*PongResponse, error)
}

PingClient is the client API for Ping service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewPingClient

func NewPingClient(cc grpc.ClientConnInterface) PingClient

type PingRequest

type PingRequest struct {

	// Message to send with the ping request.
	Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

The ping request.

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

func (*PingRequest) Validate

func (m *PingRequest) Validate() error

Validate checks the field values on PingRequest with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type PingRequestValidationError

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

PingRequestValidationError is the validation error returned by PingRequest.Validate if the designated constraints aren't met.

func (PingRequestValidationError) Cause

func (e PingRequestValidationError) Cause() error

Cause function returns cause value.

func (PingRequestValidationError) Error

func (e PingRequestValidationError) Error() string

Error satisfies the builtin error interface

func (PingRequestValidationError) ErrorName

func (e PingRequestValidationError) ErrorName() string

ErrorName returns error name.

func (PingRequestValidationError) Field

func (e PingRequestValidationError) Field() string

Field function returns field value.

func (PingRequestValidationError) Key

func (e PingRequestValidationError) Key() bool

Key function returns key value.

func (PingRequestValidationError) Reason

func (e PingRequestValidationError) Reason() string

Reason function returns reason value.

type PingServer

type PingServer interface {
	// Ping sends a ping message
	Ping(context.Context, *PingRequest) (*PongResponse, error)
}

PingServer is the server API for Ping service.

type PongResponse

type PongResponse struct {

	// Message with the pong answer.
	Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

The pong response.

func (*PongResponse) Descriptor

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

Deprecated: Use PongResponse.ProtoReflect.Descriptor instead.

func (*PongResponse) GetMessage

func (x *PongResponse) GetMessage() string

func (*PongResponse) ProtoMessage

func (*PongResponse) ProtoMessage()

func (*PongResponse) ProtoReflect

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

func (*PongResponse) Reset

func (x *PongResponse) Reset()

func (*PongResponse) String

func (x *PongResponse) String() string

func (*PongResponse) Validate

func (m *PongResponse) Validate() error

Validate checks the field values on PongResponse with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

type PongResponseValidationError

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

PongResponseValidationError is the validation error returned by PongResponse.Validate if the designated constraints aren't met.

func (PongResponseValidationError) Cause

func (e PongResponseValidationError) Cause() error

Cause function returns cause value.

func (PongResponseValidationError) Error

func (e PongResponseValidationError) Error() string

Error satisfies the builtin error interface

func (PongResponseValidationError) ErrorName

func (e PongResponseValidationError) ErrorName() string

ErrorName returns error name.

func (PongResponseValidationError) Field

func (e PongResponseValidationError) Field() string

Field function returns field value.

func (PongResponseValidationError) Key

func (e PongResponseValidationError) Key() bool

Key function returns key value.

func (PongResponseValidationError) Reason

func (e PongResponseValidationError) Reason() string

Reason function returns reason value.

type UnimplementedPingServer

type UnimplementedPingServer struct {
}

UnimplementedPingServer can be embedded to have forward compatible implementations.

func (*UnimplementedPingServer) Ping

func (*UnimplementedPingServer) Ping(context.Context, *PingRequest) (*PongResponse, error)