org

Documentation

Overview

Package org is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

• Variables
• func RegisterOrgHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
• func RegisterOrgHandlerClient(ctx context.Context, mux *runtime.ServeMux, client OrgClient) error
• func RegisterOrgHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
• func RegisterOrgHandlerServer(ctx context.Context, mux *runtime.ServeMux, server OrgServer) error
• func RegisterOrgServer(s grpc.ServiceRegistrar, srv OrgServer)
• type GetInfoRequest
  • func (*GetInfoRequest) Descriptor() ([]byte, []int)
  • func (*GetInfoRequest) ProtoMessage()
  • func (x *GetInfoRequest) ProtoReflect() protoreflect.Message
  • func (x *GetInfoRequest) Reset()
  • func (x *GetInfoRequest) String() string
• type GetInfoResponse
  • func (*GetInfoResponse) Descriptor() ([]byte, []int)
  • func (x *GetInfoResponse) GetName() string
  • func (*GetInfoResponse) ProtoMessage()
  • func (x *GetInfoResponse) ProtoReflect() protoreflect.Message
  • func (x *GetInfoResponse) Reset()
  • func (x *GetInfoResponse) String() string
• type OrgClient
  • func NewOrgClient(cc grpc.ClientConnInterface) OrgClient
• type OrgServer
• type UnimplementedOrgServer
  • func (UnimplementedOrgServer) GetInfo(context.Context, *GetInfoRequest) (*GetInfoResponse, error)
• type UnsafeOrgServer

Variables

var File_org_v1_org_proto protoreflect.FileDescriptor

var Org_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "blueapi.org.v1.Org",
	HandlerType: (*OrgServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetInfo",
			Handler:    _Org_GetInfo_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "org/v1/org.proto",
}

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

Functions

func RegisterOrgHandler

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

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

func RegisterOrgHandlerClient

func RegisterOrgHandlerClient(ctx context.Context, mux *runtime.ServeMux, client OrgClient) error

RegisterOrgHandlerClient registers the http handlers for service Org to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "OrgClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "OrgClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "OrgClient" to call the correct interceptors.

func RegisterOrgHandlerFromEndpoint

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

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

func RegisterOrgHandlerServer

func RegisterOrgHandlerServer(ctx context.Context, mux *runtime.ServeMux, server OrgServer) error

RegisterOrgHandlerServer registers the http handlers for service Org to "mux". UnaryRPC :call OrgServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterOrgHandlerFromEndpoint instead.

func RegisterOrgServer

func RegisterOrgServer(s grpc.ServiceRegistrar, srv OrgServer)

Types

type GetInfoRequest

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

Request message for Org.GetInfo.

func (*GetInfoRequest) Descriptor

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

Deprecated: Use GetInfoRequest.ProtoReflect.Descriptor instead.

func (*GetInfoRequest) ProtoMessage

func (*GetInfoRequest) ProtoMessage()

func (*GetInfoRequest) ProtoReflect

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

func (*GetInfoRequest) Reset

func (x *GetInfoRequest) Reset()

func (*GetInfoRequest) String

func (x *GetInfoRequest) String() string

type GetInfoResponse

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

Response message for Org.GetInfo.

func (*GetInfoResponse) Descriptor

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

Deprecated: Use GetInfoResponse.ProtoReflect.Descriptor instead.

func (*GetInfoResponse) GetName

func (x *GetInfoResponse) GetName() string

func (*GetInfoResponse) ProtoMessage

func (*GetInfoResponse) ProtoMessage()

func (*GetInfoResponse) ProtoReflect

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

func (*GetInfoResponse) Reset

func (x *GetInfoResponse) Reset()

func (*GetInfoResponse) String

func (x *GetInfoResponse) String() string

type OrgClient

type OrgClient interface {
	GetInfo(ctx context.Context, in *GetInfoRequest, opts ...grpc.CallOption) (*GetInfoResponse, error)
}

OrgClient is the client API for Org 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 NewOrgClient

func NewOrgClient(cc grpc.ClientConnInterface) OrgClient

type OrgServer

type OrgServer interface {
	GetInfo(context.Context, *GetInfoRequest) (*GetInfoResponse, error)
	// contains filtered or unexported methods
}

OrgServer is the server API for Org service. All implementations must embed UnimplementedOrgServer for forward compatibility

type UnimplementedOrgServer

type UnimplementedOrgServer struct {
}

UnimplementedOrgServer must be embedded to have forward compatible implementations.

func (UnimplementedOrgServer) GetInfo

func (UnimplementedOrgServer) GetInfo(context.Context, *GetInfoRequest) (*GetInfoResponse, error)

type UnsafeOrgServer

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

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