api

Documentation

Overview

Package api is a generated protocol buffer package.

It is generated from these files:

nomine.proto

It has these top-level messages:

NameCheckRequest
NameCheckResponse
MultiNameCheckRequest
MultiNameCheckResponse

Package api is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

• Variables
• func RegisterNomineHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
• func RegisterNomineHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
• func RegisterNomineServer(s *grpc.Server, srv NomineServer)
• type MultiNameCheckRequest
  • func (*MultiNameCheckRequest) Descriptor() ([]byte, []int)
  • func (m *MultiNameCheckRequest) GetName() string
  • func (m *MultiNameCheckRequest) GetServices() []string
  • func (*MultiNameCheckRequest) ProtoMessage()
  • func (m *MultiNameCheckRequest) Reset()
  • func (m *MultiNameCheckRequest) String() string
• type MultiNameCheckResponse
  • func (*MultiNameCheckResponse) Descriptor() ([]byte, []int)
  • func (m *MultiNameCheckResponse) GetResults() map[string]Result
  • func (*MultiNameCheckResponse) ProtoMessage()
  • func (m *MultiNameCheckResponse) Reset()
  • func (m *MultiNameCheckResponse) String() string
• type NameCheckRequest
  • func (*NameCheckRequest) Descriptor() ([]byte, []int)
  • func (m *NameCheckRequest) GetName() string
  • func (m *NameCheckRequest) GetService() string
  • func (*NameCheckRequest) ProtoMessage()
  • func (m *NameCheckRequest) Reset()
  • func (m *NameCheckRequest) String() string
• type NameCheckResponse
  • func (*NameCheckResponse) Descriptor() ([]byte, []int)
  • func (m *NameCheckResponse) GetResult() int32
  • func (*NameCheckResponse) ProtoMessage()
  • func (m *NameCheckResponse) Reset()
  • func (m *NameCheckResponse) String() string
• type NomineClient
  • func NewNomineClient(cc *grpc.ClientConn) NomineClient
• type NomineServer
• type Result
  • func (Result) EnumDescriptor() ([]byte, []int)
  • func (x Result) String() string

Variables

var Result_name = map[int32]string{
	0: "NOTHING",
	1: "AVAILABLE",
	2: "UNAVAILABLE",
	3: "UNKOWN",
}

var Result_value = map[string]int32{
	"NOTHING":     0,
	"AVAILABLE":   1,
	"UNAVAILABLE": 2,
	"UNKOWN":      3,
}

Functions

func RegisterNomineHandler

func RegisterNomineHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterNomineHandler registers the http handlers for service Nomine to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterNomineHandlerFromEndpoint

func RegisterNomineHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterNomineHandlerFromEndpoint is same as RegisterNomineHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterNomineServer

func RegisterNomineServer(s *grpc.Server, srv NomineServer)

Types

type MultiNameCheckRequest

type MultiNameCheckRequest struct {
	Name     string   `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	Services []string `protobuf:"bytes,2,rep,name=services" json:"services,omitempty"`
}

func (*MultiNameCheckRequest) Descriptor

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

func (*MultiNameCheckRequest) GetName

func (m *MultiNameCheckRequest) GetName() string

func (*MultiNameCheckRequest) GetServices

func (m *MultiNameCheckRequest) GetServices() []string

func (*MultiNameCheckRequest) ProtoMessage

func (*MultiNameCheckRequest) ProtoMessage()

func (*MultiNameCheckRequest) Reset

func (m *MultiNameCheckRequest) Reset()

func (*MultiNameCheckRequest) String

func (m *MultiNameCheckRequest) String() string

type MultiNameCheckResponse

type MultiNameCheckResponse struct {
	Results map[string]Result `` /* 154-byte string literal not displayed */
}

func (*MultiNameCheckResponse) Descriptor

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

func (*MultiNameCheckResponse) GetResults

func (m *MultiNameCheckResponse) GetResults() map[string]Result

func (*MultiNameCheckResponse) ProtoMessage

func (*MultiNameCheckResponse) ProtoMessage()

func (*MultiNameCheckResponse) Reset

func (m *MultiNameCheckResponse) Reset()

func (*MultiNameCheckResponse) String

func (m *MultiNameCheckResponse) String() string

type NameCheckRequest

type NameCheckRequest struct {
	Name    string `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	Service string `protobuf:"bytes,2,opt,name=service" json:"service,omitempty"`
}

func (*NameCheckRequest) Descriptor

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

func (*NameCheckRequest) GetName

func (m *NameCheckRequest) GetName() string

func (*NameCheckRequest) GetService

func (m *NameCheckRequest) GetService() string

func (*NameCheckRequest) ProtoMessage

func (*NameCheckRequest) ProtoMessage()

func (*NameCheckRequest) Reset

func (m *NameCheckRequest) Reset()

func (*NameCheckRequest) String

func (m *NameCheckRequest) String() string

type NameCheckResponse

type NameCheckResponse struct {
	Result int32 `protobuf:"varint,1,opt,name=result" json:"result,omitempty"`
}

func (*NameCheckResponse) Descriptor

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

func (*NameCheckResponse) GetResult

func (m *NameCheckResponse) GetResult() int32

func (*NameCheckResponse) ProtoMessage

func (*NameCheckResponse) ProtoMessage()

func (*NameCheckResponse) Reset

func (m *NameCheckResponse) Reset()

func (*NameCheckResponse) String

func (m *NameCheckResponse) String() string

type NomineClient

type NomineClient interface {
	Check(ctx context.Context, in *NameCheckRequest, opts ...grpc.CallOption) (*NameCheckResponse, error)
	MultiCheck(ctx context.Context, in *MultiNameCheckRequest, opts ...grpc.CallOption) (*MultiNameCheckResponse, error)
}

func NewNomineClient

func NewNomineClient(cc *grpc.ClientConn) NomineClient

type NomineServer

type NomineServer interface {
	Check(context.Context, *NameCheckRequest) (*NameCheckResponse, error)
	MultiCheck(context.Context, *MultiNameCheckRequest) (*MultiNameCheckResponse, error)
}

type Result

type Result int32

const (
	Result_NOTHING     Result = 0
	Result_AVAILABLE   Result = 1
	Result_UNAVAILABLE Result = 2
	Result_UNKOWN      Result = 3
)

func (Result) EnumDescriptor

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

func (Result) String

func (x Result) String() string