Documentation
¶
Overview ¶
Package sdk is a reverse proxy.
It translates gRPC into RESTful JSON APIs.
Index ¶
- Variables
- func RegisterSDKHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error
- func RegisterSDKHandlerClient(ctx context.Context, mux *runtime.ServeMux, client SDKClient) error
- func RegisterSDKHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, ...) (err error)
- func RegisterSDKHandlerServer(ctx context.Context, mux *runtime.ServeMux, server SDKServer) error
- func RegisterSDKServer(s grpc.ServiceRegistrar, srv SDKServer)
- type Duration
- type Empty
- type GameServer
- func (*GameServer) Descriptor() ([]byte, []int)deprecated
- func (x *GameServer) GetObjectMeta() *GameServer_ObjectMeta
- func (x *GameServer) GetSpec() *GameServer_Spec
- func (x *GameServer) GetStatus() *GameServer_Status
- func (*GameServer) ProtoMessage()
- func (x *GameServer) ProtoReflect() protoreflect.Message
- func (x *GameServer) Reset()
- func (x *GameServer) String() string
- type GameServer_ObjectMeta
- func (*GameServer_ObjectMeta) Descriptor() ([]byte, []int)deprecated
- func (x *GameServer_ObjectMeta) GetAnnotations() map[string]string
- func (x *GameServer_ObjectMeta) GetCreationTimestamp() int64
- func (x *GameServer_ObjectMeta) GetDeletionTimestamp() int64
- func (x *GameServer_ObjectMeta) GetGeneration() int64
- func (x *GameServer_ObjectMeta) GetLabels() map[string]string
- func (x *GameServer_ObjectMeta) GetName() string
- func (x *GameServer_ObjectMeta) GetNamespace() string
- func (x *GameServer_ObjectMeta) GetResourceVersion() string
- func (x *GameServer_ObjectMeta) GetUid() string
- func (*GameServer_ObjectMeta) ProtoMessage()
- func (x *GameServer_ObjectMeta) ProtoReflect() protoreflect.Message
- func (x *GameServer_ObjectMeta) Reset()
- func (x *GameServer_ObjectMeta) String() string
- type GameServer_Spec
- func (*GameServer_Spec) Descriptor() ([]byte, []int)deprecated
- func (x *GameServer_Spec) GetHealth() *GameServer_Spec_Health
- func (*GameServer_Spec) ProtoMessage()
- func (x *GameServer_Spec) ProtoReflect() protoreflect.Message
- func (x *GameServer_Spec) Reset()
- func (x *GameServer_Spec) String() string
- type GameServer_Spec_Health
- func (*GameServer_Spec_Health) Descriptor() ([]byte, []int)deprecated
- func (x *GameServer_Spec_Health) GetDisabled() bool
- func (x *GameServer_Spec_Health) GetFailureThreshold() int32
- func (x *GameServer_Spec_Health) GetInitialDelaySeconds() int32
- func (x *GameServer_Spec_Health) GetPeriodSeconds() int32
- func (*GameServer_Spec_Health) ProtoMessage()
- func (x *GameServer_Spec_Health) ProtoReflect() protoreflect.Message
- func (x *GameServer_Spec_Health) Reset()
- func (x *GameServer_Spec_Health) String() string
- type GameServer_Status
- func (*GameServer_Status) Descriptor() ([]byte, []int)deprecated
- func (x *GameServer_Status) GetAddress() string
- func (x *GameServer_Status) GetAddresses() []*GameServer_Status_Address
- func (x *GameServer_Status) GetCounters() map[string]*GameServer_Status_CounterStatus
- func (x *GameServer_Status) GetLists() map[string]*GameServer_Status_ListStatus
- func (x *GameServer_Status) GetPlayers() *GameServer_Status_PlayerStatus
- func (x *GameServer_Status) GetPorts() []*GameServer_Status_Port
- func (x *GameServer_Status) GetState() string
- func (*GameServer_Status) ProtoMessage()
- func (x *GameServer_Status) ProtoReflect() protoreflect.Message
- func (x *GameServer_Status) Reset()
- func (x *GameServer_Status) String() string
- type GameServer_Status_Address
- func (*GameServer_Status_Address) Descriptor() ([]byte, []int)deprecated
- func (x *GameServer_Status_Address) GetAddress() string
- func (x *GameServer_Status_Address) GetType() string
- func (*GameServer_Status_Address) ProtoMessage()
- func (x *GameServer_Status_Address) ProtoReflect() protoreflect.Message
- func (x *GameServer_Status_Address) Reset()
- func (x *GameServer_Status_Address) String() string
- type GameServer_Status_CounterStatus
- func (*GameServer_Status_CounterStatus) Descriptor() ([]byte, []int)deprecated
- func (x *GameServer_Status_CounterStatus) GetCapacity() int64
- func (x *GameServer_Status_CounterStatus) GetCount() int64
- func (*GameServer_Status_CounterStatus) ProtoMessage()
- func (x *GameServer_Status_CounterStatus) ProtoReflect() protoreflect.Message
- func (x *GameServer_Status_CounterStatus) Reset()
- func (x *GameServer_Status_CounterStatus) String() string
- type GameServer_Status_ListStatus
- func (*GameServer_Status_ListStatus) Descriptor() ([]byte, []int)deprecated
- func (x *GameServer_Status_ListStatus) GetCapacity() int64
- func (x *GameServer_Status_ListStatus) GetValues() []string
- func (*GameServer_Status_ListStatus) ProtoMessage()
- func (x *GameServer_Status_ListStatus) ProtoReflect() protoreflect.Message
- func (x *GameServer_Status_ListStatus) Reset()
- func (x *GameServer_Status_ListStatus) String() string
- type GameServer_Status_PlayerStatus
- func (*GameServer_Status_PlayerStatus) Descriptor() ([]byte, []int)deprecated
- func (x *GameServer_Status_PlayerStatus) GetCapacity() int64
- func (x *GameServer_Status_PlayerStatus) GetCount() int64
- func (x *GameServer_Status_PlayerStatus) GetIds() []string
- func (*GameServer_Status_PlayerStatus) ProtoMessage()
- func (x *GameServer_Status_PlayerStatus) ProtoReflect() protoreflect.Message
- func (x *GameServer_Status_PlayerStatus) Reset()
- func (x *GameServer_Status_PlayerStatus) String() string
- type GameServer_Status_Port
- func (*GameServer_Status_Port) Descriptor() ([]byte, []int)deprecated
- func (x *GameServer_Status_Port) GetName() string
- func (x *GameServer_Status_Port) GetPort() int32
- func (*GameServer_Status_Port) ProtoMessage()
- func (x *GameServer_Status_Port) ProtoReflect() protoreflect.Message
- func (x *GameServer_Status_Port) Reset()
- func (x *GameServer_Status_Port) String() string
- type KeyValue
- type SDKClient
- type SDKServer
- type SDK_HealthClient
- type SDK_HealthServer
- type SDK_WatchGameServerClient
- type SDK_WatchGameServerServer
- type UnimplementedSDKServer
- func (UnimplementedSDKServer) Allocate(context.Context, *Empty) (*Empty, error)
- func (UnimplementedSDKServer) GetGameServer(context.Context, *Empty) (*GameServer, error)
- func (UnimplementedSDKServer) Health(SDK_HealthServer) error
- func (UnimplementedSDKServer) Ready(context.Context, *Empty) (*Empty, error)
- func (UnimplementedSDKServer) Reserve(context.Context, *Duration) (*Empty, error)
- func (UnimplementedSDKServer) SetAnnotation(context.Context, *KeyValue) (*Empty, error)
- func (UnimplementedSDKServer) SetLabel(context.Context, *KeyValue) (*Empty, error)
- func (UnimplementedSDKServer) Shutdown(context.Context, *Empty) (*Empty, error)
- func (UnimplementedSDKServer) WatchGameServer(*Empty, SDK_WatchGameServerServer) error
- type UnsafeSDKServer
Constants ¶
This section is empty.
Variables ¶
var File_sdk_proto protoreflect.FileDescriptor
var SDK_ServiceDesc = grpc.ServiceDesc{ ServiceName: "agones.dev.sdk.SDK", HandlerType: (*SDKServer)(nil), Methods: []grpc.MethodDesc{ { MethodName: "Ready", Handler: _SDK_Ready_Handler, }, { MethodName: "Allocate", Handler: _SDK_Allocate_Handler, }, { MethodName: "Shutdown", Handler: _SDK_Shutdown_Handler, }, { MethodName: "GetGameServer", Handler: _SDK_GetGameServer_Handler, }, { MethodName: "SetLabel", Handler: _SDK_SetLabel_Handler, }, { MethodName: "SetAnnotation", Handler: _SDK_SetAnnotation_Handler, }, { MethodName: "Reserve", Handler: _SDK_Reserve_Handler, }, }, Streams: []grpc.StreamDesc{ { StreamName: "Health", Handler: _SDK_Health_Handler, ClientStreams: true, }, { StreamName: "WatchGameServer", Handler: _SDK_WatchGameServer_Handler, ServerStreams: true, }, }, Metadata: "sdk.proto", }
SDK_ServiceDesc is the grpc.ServiceDesc for SDK service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)
Functions ¶
func RegisterSDKHandler ¶ added in v0.3.0
RegisterSDKHandler registers the http handlers for service SDK to "mux". The handlers forward requests to the grpc endpoint over "conn".
func RegisterSDKHandlerClient ¶ added in v0.3.0
RegisterSDKHandlerClient registers the http handlers for service SDK to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "SDKClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "SDKClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "SDKClient" to call the correct interceptors. This client ignores the HTTP middlewares.
func RegisterSDKHandlerFromEndpoint ¶ added in v0.3.0
func RegisterSDKHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)
RegisterSDKHandlerFromEndpoint is same as RegisterSDKHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.
func RegisterSDKHandlerServer ¶ added in v1.3.0
RegisterSDKHandlerServer registers the http handlers for service SDK to "mux". UnaryRPC :call SDKServer 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 RegisterSDKHandlerFromEndpoint instead. GRPC interceptors will not work for this type of registration. To use interceptors, you must use the "runtime.WithMiddlewares" option in the "runtime.NewServeMux" call.
func RegisterSDKServer ¶
func RegisterSDKServer(s grpc.ServiceRegistrar, srv SDKServer)
Types ¶
type Duration ¶ added in v0.12.0
type Duration struct { Seconds int64 `protobuf:"varint,1,opt,name=seconds,proto3" json:"seconds,omitempty"` // contains filtered or unexported fields }
time duration, in seconds
func (*Duration) Descriptor
deprecated
added in
v0.12.0
func (*Duration) GetSeconds ¶ added in v0.12.0
func (*Duration) ProtoMessage ¶ added in v0.12.0
func (*Duration) ProtoMessage()
func (*Duration) ProtoReflect ¶ added in v1.29.0
func (x *Duration) ProtoReflect() protoreflect.Message
type Empty ¶
type Empty struct {
// contains filtered or unexported fields
}
I am Empty
func (*Empty) Descriptor
deprecated
func (*Empty) ProtoMessage ¶
func (*Empty) ProtoMessage()
func (*Empty) ProtoReflect ¶ added in v1.29.0
func (x *Empty) ProtoReflect() protoreflect.Message
type GameServer ¶ added in v0.3.0
type GameServer struct { ObjectMeta *GameServer_ObjectMeta `protobuf:"bytes,1,opt,name=object_meta,json=objectMeta,proto3" json:"object_meta,omitempty"` Spec *GameServer_Spec `protobuf:"bytes,2,opt,name=spec,proto3" json:"spec,omitempty"` Status *GameServer_Status `protobuf:"bytes,3,opt,name=status,proto3" json:"status,omitempty"` // contains filtered or unexported fields }
A GameServer Custom Resource Definition object We will only export those resources that make the most sense. Can always expand to more as needed.
func (*GameServer) Descriptor
deprecated
added in
v0.3.0
func (*GameServer) Descriptor() ([]byte, []int)
Deprecated: Use GameServer.ProtoReflect.Descriptor instead.
func (*GameServer) GetObjectMeta ¶ added in v0.3.0
func (x *GameServer) GetObjectMeta() *GameServer_ObjectMeta
func (*GameServer) GetSpec ¶ added in v0.3.0
func (x *GameServer) GetSpec() *GameServer_Spec
func (*GameServer) GetStatus ¶ added in v0.3.0
func (x *GameServer) GetStatus() *GameServer_Status
func (*GameServer) ProtoMessage ¶ added in v0.3.0
func (*GameServer) ProtoMessage()
func (*GameServer) ProtoReflect ¶ added in v1.29.0
func (x *GameServer) ProtoReflect() protoreflect.Message
func (*GameServer) Reset ¶ added in v0.3.0
func (x *GameServer) Reset()
func (*GameServer) String ¶ added in v0.3.0
func (x *GameServer) String() string
type GameServer_ObjectMeta ¶ added in v0.3.0
type GameServer_ObjectMeta struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` Namespace string `protobuf:"bytes,2,opt,name=namespace,proto3" json:"namespace,omitempty"` Uid string `protobuf:"bytes,3,opt,name=uid,proto3" json:"uid,omitempty"` ResourceVersion string `protobuf:"bytes,4,opt,name=resource_version,json=resourceVersion,proto3" json:"resource_version,omitempty"` Generation int64 `protobuf:"varint,5,opt,name=generation,proto3" json:"generation,omitempty"` // timestamp is in Epoch format, unit: seconds CreationTimestamp int64 `protobuf:"varint,6,opt,name=creation_timestamp,json=creationTimestamp,proto3" json:"creation_timestamp,omitempty"` // optional deletion timestamp in Epoch format, unit: seconds DeletionTimestamp int64 `protobuf:"varint,7,opt,name=deletion_timestamp,json=deletionTimestamp,proto3" json:"deletion_timestamp,omitempty"` Annotations map[string]string `` /* 163-byte string literal not displayed */ Labels map[string]string `` /* 153-byte string literal not displayed */ // contains filtered or unexported fields }
representation of the K8s ObjectMeta resource
func (*GameServer_ObjectMeta) Descriptor
deprecated
added in
v0.3.0
func (*GameServer_ObjectMeta) Descriptor() ([]byte, []int)
Deprecated: Use GameServer_ObjectMeta.ProtoReflect.Descriptor instead.
func (*GameServer_ObjectMeta) GetAnnotations ¶ added in v0.3.0
func (x *GameServer_ObjectMeta) GetAnnotations() map[string]string
func (*GameServer_ObjectMeta) GetCreationTimestamp ¶ added in v0.3.0
func (x *GameServer_ObjectMeta) GetCreationTimestamp() int64
func (*GameServer_ObjectMeta) GetDeletionTimestamp ¶ added in v0.3.0
func (x *GameServer_ObjectMeta) GetDeletionTimestamp() int64
func (*GameServer_ObjectMeta) GetGeneration ¶ added in v0.3.0
func (x *GameServer_ObjectMeta) GetGeneration() int64
func (*GameServer_ObjectMeta) GetLabels ¶ added in v0.3.0
func (x *GameServer_ObjectMeta) GetLabels() map[string]string
func (*GameServer_ObjectMeta) GetName ¶ added in v0.3.0
func (x *GameServer_ObjectMeta) GetName() string
func (*GameServer_ObjectMeta) GetNamespace ¶ added in v0.3.0
func (x *GameServer_ObjectMeta) GetNamespace() string
func (*GameServer_ObjectMeta) GetResourceVersion ¶ added in v0.3.0
func (x *GameServer_ObjectMeta) GetResourceVersion() string
func (*GameServer_ObjectMeta) GetUid ¶ added in v0.3.0
func (x *GameServer_ObjectMeta) GetUid() string
func (*GameServer_ObjectMeta) ProtoMessage ¶ added in v0.3.0
func (*GameServer_ObjectMeta) ProtoMessage()
func (*GameServer_ObjectMeta) ProtoReflect ¶ added in v1.29.0
func (x *GameServer_ObjectMeta) ProtoReflect() protoreflect.Message
func (*GameServer_ObjectMeta) Reset ¶ added in v0.3.0
func (x *GameServer_ObjectMeta) Reset()
func (*GameServer_ObjectMeta) String ¶ added in v0.3.0
func (x *GameServer_ObjectMeta) String() string
type GameServer_Spec ¶ added in v0.3.0
type GameServer_Spec struct { Health *GameServer_Spec_Health `protobuf:"bytes,1,opt,name=health,proto3" json:"health,omitempty"` // contains filtered or unexported fields }
func (*GameServer_Spec) Descriptor
deprecated
added in
v0.3.0
func (*GameServer_Spec) Descriptor() ([]byte, []int)
Deprecated: Use GameServer_Spec.ProtoReflect.Descriptor instead.
func (*GameServer_Spec) GetHealth ¶ added in v0.3.0
func (x *GameServer_Spec) GetHealth() *GameServer_Spec_Health
func (*GameServer_Spec) ProtoMessage ¶ added in v0.3.0
func (*GameServer_Spec) ProtoMessage()
func (*GameServer_Spec) ProtoReflect ¶ added in v1.29.0
func (x *GameServer_Spec) ProtoReflect() protoreflect.Message
func (*GameServer_Spec) Reset ¶ added in v0.3.0
func (x *GameServer_Spec) Reset()
func (*GameServer_Spec) String ¶ added in v0.3.0
func (x *GameServer_Spec) String() string
type GameServer_Spec_Health ¶ added in v0.3.0
type GameServer_Spec_Health struct { Disabled bool `protobuf:"varint,1,opt,name=disabled,proto3" json:"disabled,omitempty"` PeriodSeconds int32 `protobuf:"varint,2,opt,name=period_seconds,json=periodSeconds,proto3" json:"period_seconds,omitempty"` FailureThreshold int32 `protobuf:"varint,3,opt,name=failure_threshold,json=failureThreshold,proto3" json:"failure_threshold,omitempty"` InitialDelaySeconds int32 `protobuf:"varint,4,opt,name=initial_delay_seconds,json=initialDelaySeconds,proto3" json:"initial_delay_seconds,omitempty"` // contains filtered or unexported fields }
func (*GameServer_Spec_Health) Descriptor
deprecated
added in
v0.3.0
func (*GameServer_Spec_Health) Descriptor() ([]byte, []int)
Deprecated: Use GameServer_Spec_Health.ProtoReflect.Descriptor instead.
func (*GameServer_Spec_Health) GetDisabled ¶ added in v0.3.0
func (x *GameServer_Spec_Health) GetDisabled() bool
func (*GameServer_Spec_Health) GetFailureThreshold ¶ added in v0.3.0
func (x *GameServer_Spec_Health) GetFailureThreshold() int32
func (*GameServer_Spec_Health) GetInitialDelaySeconds ¶ added in v0.3.0
func (x *GameServer_Spec_Health) GetInitialDelaySeconds() int32
func (*GameServer_Spec_Health) GetPeriodSeconds ¶ added in v0.3.0
func (x *GameServer_Spec_Health) GetPeriodSeconds() int32
func (*GameServer_Spec_Health) ProtoMessage ¶ added in v0.3.0
func (*GameServer_Spec_Health) ProtoMessage()
func (*GameServer_Spec_Health) ProtoReflect ¶ added in v1.29.0
func (x *GameServer_Spec_Health) ProtoReflect() protoreflect.Message
func (*GameServer_Spec_Health) Reset ¶ added in v0.3.0
func (x *GameServer_Spec_Health) Reset()
func (*GameServer_Spec_Health) String ¶ added in v0.3.0
func (x *GameServer_Spec_Health) String() string
type GameServer_Status ¶ added in v0.3.0
type GameServer_Status struct { State string `protobuf:"bytes,1,opt,name=state,proto3" json:"state,omitempty"` Address string `protobuf:"bytes,2,opt,name=address,proto3" json:"address,omitempty"` Addresses []*GameServer_Status_Address `protobuf:"bytes,7,rep,name=addresses,proto3" json:"addresses,omitempty"` Ports []*GameServer_Status_Port `protobuf:"bytes,3,rep,name=ports,proto3" json:"ports,omitempty"` // [Stage:Alpha] // [FeatureFlag:PlayerTracking] Players *GameServer_Status_PlayerStatus `protobuf:"bytes,4,opt,name=players,proto3" json:"players,omitempty"` // [Stage:Beta] // [FeatureFlag:CountsAndLists] Counters map[string]*GameServer_Status_CounterStatus `` /* 157-byte string literal not displayed */ // [Stage:Beta] // [FeatureFlag:CountsAndLists] Lists map[string]*GameServer_Status_ListStatus `` /* 151-byte string literal not displayed */ // contains filtered or unexported fields }
func (*GameServer_Status) Descriptor
deprecated
added in
v0.3.0
func (*GameServer_Status) Descriptor() ([]byte, []int)
Deprecated: Use GameServer_Status.ProtoReflect.Descriptor instead.
func (*GameServer_Status) GetAddress ¶ added in v0.3.0
func (x *GameServer_Status) GetAddress() string
func (*GameServer_Status) GetAddresses ¶ added in v1.34.0
func (x *GameServer_Status) GetAddresses() []*GameServer_Status_Address
func (*GameServer_Status) GetCounters ¶ added in v1.31.0
func (x *GameServer_Status) GetCounters() map[string]*GameServer_Status_CounterStatus
func (*GameServer_Status) GetLists ¶ added in v1.31.0
func (x *GameServer_Status) GetLists() map[string]*GameServer_Status_ListStatus
func (*GameServer_Status) GetPlayers ¶ added in v1.5.0
func (x *GameServer_Status) GetPlayers() *GameServer_Status_PlayerStatus
func (*GameServer_Status) GetPorts ¶ added in v0.3.0
func (x *GameServer_Status) GetPorts() []*GameServer_Status_Port
func (*GameServer_Status) GetState ¶ added in v0.3.0
func (x *GameServer_Status) GetState() string
func (*GameServer_Status) ProtoMessage ¶ added in v0.3.0
func (*GameServer_Status) ProtoMessage()
func (*GameServer_Status) ProtoReflect ¶ added in v1.29.0
func (x *GameServer_Status) ProtoReflect() protoreflect.Message
func (*GameServer_Status) Reset ¶ added in v0.3.0
func (x *GameServer_Status) Reset()
func (*GameServer_Status) String ¶ added in v0.3.0
func (x *GameServer_Status) String() string
type GameServer_Status_Address ¶ added in v1.34.0
type GameServer_Status_Address struct { Type string `protobuf:"bytes,1,opt,name=type,proto3" json:"type,omitempty"` Address string `protobuf:"bytes,2,opt,name=address,proto3" json:"address,omitempty"` // contains filtered or unexported fields }
func (*GameServer_Status_Address) Descriptor
deprecated
added in
v1.34.0
func (*GameServer_Status_Address) Descriptor() ([]byte, []int)
Deprecated: Use GameServer_Status_Address.ProtoReflect.Descriptor instead.
func (*GameServer_Status_Address) GetAddress ¶ added in v1.34.0
func (x *GameServer_Status_Address) GetAddress() string
func (*GameServer_Status_Address) GetType ¶ added in v1.34.0
func (x *GameServer_Status_Address) GetType() string
func (*GameServer_Status_Address) ProtoMessage ¶ added in v1.34.0
func (*GameServer_Status_Address) ProtoMessage()
func (*GameServer_Status_Address) ProtoReflect ¶ added in v1.34.0
func (x *GameServer_Status_Address) ProtoReflect() protoreflect.Message
func (*GameServer_Status_Address) Reset ¶ added in v1.34.0
func (x *GameServer_Status_Address) Reset()
func (*GameServer_Status_Address) String ¶ added in v1.34.0
func (x *GameServer_Status_Address) String() string
type GameServer_Status_CounterStatus ¶ added in v1.31.0
type GameServer_Status_CounterStatus struct { Count int64 `protobuf:"varint,1,opt,name=count,proto3" json:"count,omitempty"` Capacity int64 `protobuf:"varint,2,opt,name=capacity,proto3" json:"capacity,omitempty"` // contains filtered or unexported fields }
[Stage:Beta] [FeatureFlag:CountsAndLists]
func (*GameServer_Status_CounterStatus) Descriptor
deprecated
added in
v1.31.0
func (*GameServer_Status_CounterStatus) Descriptor() ([]byte, []int)
Deprecated: Use GameServer_Status_CounterStatus.ProtoReflect.Descriptor instead.
func (*GameServer_Status_CounterStatus) GetCapacity ¶ added in v1.31.0
func (x *GameServer_Status_CounterStatus) GetCapacity() int64
func (*GameServer_Status_CounterStatus) GetCount ¶ added in v1.31.0
func (x *GameServer_Status_CounterStatus) GetCount() int64
func (*GameServer_Status_CounterStatus) ProtoMessage ¶ added in v1.31.0
func (*GameServer_Status_CounterStatus) ProtoMessage()
func (*GameServer_Status_CounterStatus) ProtoReflect ¶ added in v1.31.0
func (x *GameServer_Status_CounterStatus) ProtoReflect() protoreflect.Message
func (*GameServer_Status_CounterStatus) Reset ¶ added in v1.31.0
func (x *GameServer_Status_CounterStatus) Reset()
func (*GameServer_Status_CounterStatus) String ¶ added in v1.31.0
func (x *GameServer_Status_CounterStatus) String() string
type GameServer_Status_ListStatus ¶ added in v1.31.0
type GameServer_Status_ListStatus struct { Capacity int64 `protobuf:"varint,1,opt,name=capacity,proto3" json:"capacity,omitempty"` Values []string `protobuf:"bytes,2,rep,name=values,proto3" json:"values,omitempty"` // contains filtered or unexported fields }
[Stage:Beta] [FeatureFlag:CountsAndLists]
func (*GameServer_Status_ListStatus) Descriptor
deprecated
added in
v1.31.0
func (*GameServer_Status_ListStatus) Descriptor() ([]byte, []int)
Deprecated: Use GameServer_Status_ListStatus.ProtoReflect.Descriptor instead.
func (*GameServer_Status_ListStatus) GetCapacity ¶ added in v1.31.0
func (x *GameServer_Status_ListStatus) GetCapacity() int64
func (*GameServer_Status_ListStatus) GetValues ¶ added in v1.31.0
func (x *GameServer_Status_ListStatus) GetValues() []string
func (*GameServer_Status_ListStatus) ProtoMessage ¶ added in v1.31.0
func (*GameServer_Status_ListStatus) ProtoMessage()
func (*GameServer_Status_ListStatus) ProtoReflect ¶ added in v1.31.0
func (x *GameServer_Status_ListStatus) ProtoReflect() protoreflect.Message
func (*GameServer_Status_ListStatus) Reset ¶ added in v1.31.0
func (x *GameServer_Status_ListStatus) Reset()
func (*GameServer_Status_ListStatus) String ¶ added in v1.31.0
func (x *GameServer_Status_ListStatus) String() string
type GameServer_Status_PlayerStatus ¶ added in v1.5.0
type GameServer_Status_PlayerStatus struct { Count int64 `protobuf:"varint,1,opt,name=count,proto3" json:"count,omitempty"` Capacity int64 `protobuf:"varint,2,opt,name=capacity,proto3" json:"capacity,omitempty"` Ids []string `protobuf:"bytes,3,rep,name=ids,proto3" json:"ids,omitempty"` // contains filtered or unexported fields }
[Stage:Alpha] [FeatureFlag:PlayerTracking]
func (*GameServer_Status_PlayerStatus) Descriptor
deprecated
added in
v1.5.0
func (*GameServer_Status_PlayerStatus) Descriptor() ([]byte, []int)
Deprecated: Use GameServer_Status_PlayerStatus.ProtoReflect.Descriptor instead.
func (*GameServer_Status_PlayerStatus) GetCapacity ¶ added in v1.5.0
func (x *GameServer_Status_PlayerStatus) GetCapacity() int64
func (*GameServer_Status_PlayerStatus) GetCount ¶ added in v1.5.0
func (x *GameServer_Status_PlayerStatus) GetCount() int64
func (*GameServer_Status_PlayerStatus) GetIds ¶ added in v1.6.0
func (x *GameServer_Status_PlayerStatus) GetIds() []string
func (*GameServer_Status_PlayerStatus) ProtoMessage ¶ added in v1.5.0
func (*GameServer_Status_PlayerStatus) ProtoMessage()
func (*GameServer_Status_PlayerStatus) ProtoReflect ¶ added in v1.29.0
func (x *GameServer_Status_PlayerStatus) ProtoReflect() protoreflect.Message
func (*GameServer_Status_PlayerStatus) Reset ¶ added in v1.5.0
func (x *GameServer_Status_PlayerStatus) Reset()
func (*GameServer_Status_PlayerStatus) String ¶ added in v1.5.0
func (x *GameServer_Status_PlayerStatus) String() string
type GameServer_Status_Port ¶ added in v0.3.0
type GameServer_Status_Port struct { Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"` Port int32 `protobuf:"varint,2,opt,name=port,proto3" json:"port,omitempty"` // contains filtered or unexported fields }
func (*GameServer_Status_Port) Descriptor
deprecated
added in
v0.3.0
func (*GameServer_Status_Port) Descriptor() ([]byte, []int)
Deprecated: Use GameServer_Status_Port.ProtoReflect.Descriptor instead.
func (*GameServer_Status_Port) GetName ¶ added in v0.3.0
func (x *GameServer_Status_Port) GetName() string
func (*GameServer_Status_Port) GetPort ¶ added in v0.3.0
func (x *GameServer_Status_Port) GetPort() int32
func (*GameServer_Status_Port) ProtoMessage ¶ added in v0.3.0
func (*GameServer_Status_Port) ProtoMessage()
func (*GameServer_Status_Port) ProtoReflect ¶ added in v1.29.0
func (x *GameServer_Status_Port) ProtoReflect() protoreflect.Message
func (*GameServer_Status_Port) Reset ¶ added in v0.3.0
func (x *GameServer_Status_Port) Reset()
func (*GameServer_Status_Port) String ¶ added in v0.3.0
func (x *GameServer_Status_Port) String() string
type KeyValue ¶ added in v0.4.0
type KeyValue struct { Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"` Value string `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"` // contains filtered or unexported fields }
Key, Value entry
func (*KeyValue) Descriptor
deprecated
added in
v0.4.0
func (*KeyValue) ProtoMessage ¶ added in v0.4.0
func (*KeyValue) ProtoMessage()
func (*KeyValue) ProtoReflect ¶ added in v1.29.0
func (x *KeyValue) ProtoReflect() protoreflect.Message
type SDKClient ¶
type SDKClient interface { // Call when the GameServer is ready Ready(ctx context.Context, in *Empty, opts ...grpc.CallOption) (*Empty, error) // Call to self Allocation the GameServer Allocate(ctx context.Context, in *Empty, opts ...grpc.CallOption) (*Empty, error) // Call when the GameServer is shutting down Shutdown(ctx context.Context, in *Empty, opts ...grpc.CallOption) (*Empty, error) // Send a Empty every d Duration to declare that this GameSever is healthy Health(ctx context.Context, opts ...grpc.CallOption) (SDK_HealthClient, error) // Retrieve the current GameServer data GetGameServer(ctx context.Context, in *Empty, opts ...grpc.CallOption) (*GameServer, error) // Send GameServer details whenever the GameServer is updated WatchGameServer(ctx context.Context, in *Empty, opts ...grpc.CallOption) (SDK_WatchGameServerClient, error) // Apply a Label to the backing GameServer metadata SetLabel(ctx context.Context, in *KeyValue, opts ...grpc.CallOption) (*Empty, error) // Apply a Annotation to the backing GameServer metadata SetAnnotation(ctx context.Context, in *KeyValue, opts ...grpc.CallOption) (*Empty, error) // Marks the GameServer as the Reserved state for Duration Reserve(ctx context.Context, in *Duration, opts ...grpc.CallOption) (*Empty, error) }
SDKClient is the client API for SDK 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 NewSDKClient ¶
func NewSDKClient(cc grpc.ClientConnInterface) SDKClient
type SDKServer ¶
type SDKServer interface { // Call when the GameServer is ready Ready(context.Context, *Empty) (*Empty, error) // Call to self Allocation the GameServer Allocate(context.Context, *Empty) (*Empty, error) // Call when the GameServer is shutting down Shutdown(context.Context, *Empty) (*Empty, error) // Send a Empty every d Duration to declare that this GameSever is healthy Health(SDK_HealthServer) error // Retrieve the current GameServer data GetGameServer(context.Context, *Empty) (*GameServer, error) // Send GameServer details whenever the GameServer is updated WatchGameServer(*Empty, SDK_WatchGameServerServer) error // Apply a Label to the backing GameServer metadata SetLabel(context.Context, *KeyValue) (*Empty, error) // Apply a Annotation to the backing GameServer metadata SetAnnotation(context.Context, *KeyValue) (*Empty, error) // Marks the GameServer as the Reserved state for Duration Reserve(context.Context, *Duration) (*Empty, error) }
SDKServer is the server API for SDK service. All implementations should embed UnimplementedSDKServer for forward compatibility
type SDK_HealthClient ¶
type SDK_HealthServer ¶
type SDK_WatchGameServerClient ¶ added in v0.4.0
type SDK_WatchGameServerClient interface { Recv() (*GameServer, error) grpc.ClientStream }
type SDK_WatchGameServerServer ¶ added in v0.4.0
type SDK_WatchGameServerServer interface { Send(*GameServer) error grpc.ServerStream }
type UnimplementedSDKServer ¶ added in v1.29.0
type UnimplementedSDKServer struct { }
UnimplementedSDKServer should be embedded to have forward compatible implementations.
func (UnimplementedSDKServer) GetGameServer ¶ added in v1.29.0
func (UnimplementedSDKServer) GetGameServer(context.Context, *Empty) (*GameServer, error)
func (UnimplementedSDKServer) Health ¶ added in v1.29.0
func (UnimplementedSDKServer) Health(SDK_HealthServer) error
func (UnimplementedSDKServer) SetAnnotation ¶ added in v1.29.0
func (UnimplementedSDKServer) WatchGameServer ¶ added in v1.29.0
func (UnimplementedSDKServer) WatchGameServer(*Empty, SDK_WatchGameServerServer) error
type UnsafeSDKServer ¶ added in v1.29.0
type UnsafeSDKServer interface {
// contains filtered or unexported methods
}
UnsafeSDKServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to SDKServer will result in compilation errors.