agones: agones.dev/agones/pkg/sdk Index | Files

package sdk

import "agones.dev/agones/pkg/sdk"

Package sdk is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Package Files

sdk.pb.go sdk.pb.gw.go

func RegisterSDKHandler Uses

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

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

func RegisterSDKHandlerClient Uses

func RegisterSDKHandlerClient(ctx context.Context, mux *runtime.ServeMux, client SDKClient) error

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.

func RegisterSDKHandlerFromEndpoint Uses

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 RegisterSDKServer Uses

func RegisterSDKServer(s *grpc.Server, srv SDKServer)

type Duration Uses

type Duration struct {
    Seconds              int64    `protobuf:"varint,1,opt,name=seconds,proto3" json:"seconds,omitempty"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

time duration, in seconds

func (*Duration) Descriptor Uses

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

func (*Duration) GetSeconds Uses

func (m *Duration) GetSeconds() int64

func (*Duration) ProtoMessage Uses

func (*Duration) ProtoMessage()

func (*Duration) Reset Uses

func (m *Duration) Reset()

func (*Duration) String Uses

func (m *Duration) String() string

func (*Duration) XXX_DiscardUnknown Uses

func (m *Duration) XXX_DiscardUnknown()

func (*Duration) XXX_Marshal Uses

func (m *Duration) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Duration) XXX_Merge Uses

func (dst *Duration) XXX_Merge(src proto.Message)

func (*Duration) XXX_Size Uses

func (m *Duration) XXX_Size() int

func (*Duration) XXX_Unmarshal Uses

func (m *Duration) XXX_Unmarshal(b []byte) error

type Empty Uses

type Empty struct {
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

I am Empty

func (*Empty) Descriptor Uses

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

func (*Empty) ProtoMessage Uses

func (*Empty) ProtoMessage()

func (*Empty) Reset Uses

func (m *Empty) Reset()

func (*Empty) String Uses

func (m *Empty) String() string

func (*Empty) XXX_DiscardUnknown Uses

func (m *Empty) XXX_DiscardUnknown()

func (*Empty) XXX_Marshal Uses

func (m *Empty) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*Empty) XXX_Merge Uses

func (dst *Empty) XXX_Merge(src proto.Message)

func (*Empty) XXX_Size Uses

func (m *Empty) XXX_Size() int

func (*Empty) XXX_Unmarshal Uses

func (m *Empty) XXX_Unmarshal(b []byte) error

type GameServer Uses

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"`
    XXX_NoUnkeyedLiteral struct{}               `json:"-"`
    XXX_unrecognized     []byte                 `json:"-"`
    XXX_sizecache        int32                  `json:"-"`
}

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 Uses

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

func (*GameServer) GetObjectMeta Uses

func (m *GameServer) GetObjectMeta() *GameServer_ObjectMeta

func (*GameServer) GetSpec Uses

func (m *GameServer) GetSpec() *GameServer_Spec

func (*GameServer) GetStatus Uses

func (m *GameServer) GetStatus() *GameServer_Status

func (*GameServer) ProtoMessage Uses

func (*GameServer) ProtoMessage()

func (*GameServer) Reset Uses

func (m *GameServer) Reset()

func (*GameServer) String Uses

func (m *GameServer) String() string

func (*GameServer) XXX_DiscardUnknown Uses

func (m *GameServer) XXX_DiscardUnknown()

func (*GameServer) XXX_Marshal Uses

func (m *GameServer) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GameServer) XXX_Merge Uses

func (dst *GameServer) XXX_Merge(src proto.Message)

func (*GameServer) XXX_Size Uses

func (m *GameServer) XXX_Size() int

func (*GameServer) XXX_Unmarshal Uses

func (m *GameServer) XXX_Unmarshal(b []byte) error

type GameServer_ObjectMeta Uses

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 `protobuf:"bytes,8,rep,name=annotations,proto3" json:"annotations,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
    Labels               map[string]string `protobuf:"bytes,9,rep,name=labels,proto3" json:"labels,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
    XXX_NoUnkeyedLiteral struct{}          `json:"-"`
    XXX_unrecognized     []byte            `json:"-"`
    XXX_sizecache        int32             `json:"-"`
}

representation of the K8s ObjectMeta resource

func (*GameServer_ObjectMeta) Descriptor Uses

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

func (*GameServer_ObjectMeta) GetAnnotations Uses

func (m *GameServer_ObjectMeta) GetAnnotations() map[string]string

func (*GameServer_ObjectMeta) GetCreationTimestamp Uses

func (m *GameServer_ObjectMeta) GetCreationTimestamp() int64

func (*GameServer_ObjectMeta) GetDeletionTimestamp Uses

func (m *GameServer_ObjectMeta) GetDeletionTimestamp() int64

func (*GameServer_ObjectMeta) GetGeneration Uses

func (m *GameServer_ObjectMeta) GetGeneration() int64

func (*GameServer_ObjectMeta) GetLabels Uses

func (m *GameServer_ObjectMeta) GetLabels() map[string]string

func (*GameServer_ObjectMeta) GetName Uses

func (m *GameServer_ObjectMeta) GetName() string

func (*GameServer_ObjectMeta) GetNamespace Uses

func (m *GameServer_ObjectMeta) GetNamespace() string

func (*GameServer_ObjectMeta) GetResourceVersion Uses

func (m *GameServer_ObjectMeta) GetResourceVersion() string

func (*GameServer_ObjectMeta) GetUid Uses

func (m *GameServer_ObjectMeta) GetUid() string

func (*GameServer_ObjectMeta) ProtoMessage Uses

func (*GameServer_ObjectMeta) ProtoMessage()

func (*GameServer_ObjectMeta) Reset Uses

func (m *GameServer_ObjectMeta) Reset()

func (*GameServer_ObjectMeta) String Uses

func (m *GameServer_ObjectMeta) String() string

func (*GameServer_ObjectMeta) XXX_DiscardUnknown Uses

func (m *GameServer_ObjectMeta) XXX_DiscardUnknown()

func (*GameServer_ObjectMeta) XXX_Marshal Uses

func (m *GameServer_ObjectMeta) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GameServer_ObjectMeta) XXX_Merge Uses

func (dst *GameServer_ObjectMeta) XXX_Merge(src proto.Message)

func (*GameServer_ObjectMeta) XXX_Size Uses

func (m *GameServer_ObjectMeta) XXX_Size() int

func (*GameServer_ObjectMeta) XXX_Unmarshal Uses

func (m *GameServer_ObjectMeta) XXX_Unmarshal(b []byte) error

type GameServer_Spec Uses

type GameServer_Spec struct {
    Health               *GameServer_Spec_Health `protobuf:"bytes,1,opt,name=health,proto3" json:"health,omitempty"`
    XXX_NoUnkeyedLiteral struct{}                `json:"-"`
    XXX_unrecognized     []byte                  `json:"-"`
    XXX_sizecache        int32                   `json:"-"`
}

func (*GameServer_Spec) Descriptor Uses

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

func (*GameServer_Spec) GetHealth Uses

func (m *GameServer_Spec) GetHealth() *GameServer_Spec_Health

func (*GameServer_Spec) ProtoMessage Uses

func (*GameServer_Spec) ProtoMessage()

func (*GameServer_Spec) Reset Uses

func (m *GameServer_Spec) Reset()

func (*GameServer_Spec) String Uses

func (m *GameServer_Spec) String() string

func (*GameServer_Spec) XXX_DiscardUnknown Uses

func (m *GameServer_Spec) XXX_DiscardUnknown()

func (*GameServer_Spec) XXX_Marshal Uses

func (m *GameServer_Spec) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GameServer_Spec) XXX_Merge Uses

func (dst *GameServer_Spec) XXX_Merge(src proto.Message)

func (*GameServer_Spec) XXX_Size Uses

func (m *GameServer_Spec) XXX_Size() int

func (*GameServer_Spec) XXX_Unmarshal Uses

func (m *GameServer_Spec) XXX_Unmarshal(b []byte) error

type GameServer_Spec_Health Uses

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"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

func (*GameServer_Spec_Health) Descriptor Uses

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

func (*GameServer_Spec_Health) GetDisabled Uses

func (m *GameServer_Spec_Health) GetDisabled() bool

func (*GameServer_Spec_Health) GetFailureThreshold Uses

func (m *GameServer_Spec_Health) GetFailureThreshold() int32

func (*GameServer_Spec_Health) GetInitialDelaySeconds Uses

func (m *GameServer_Spec_Health) GetInitialDelaySeconds() int32

func (*GameServer_Spec_Health) GetPeriodSeconds Uses

func (m *GameServer_Spec_Health) GetPeriodSeconds() int32

func (*GameServer_Spec_Health) ProtoMessage Uses

func (*GameServer_Spec_Health) ProtoMessage()

func (*GameServer_Spec_Health) Reset Uses

func (m *GameServer_Spec_Health) Reset()

func (*GameServer_Spec_Health) String Uses

func (m *GameServer_Spec_Health) String() string

func (*GameServer_Spec_Health) XXX_DiscardUnknown Uses

func (m *GameServer_Spec_Health) XXX_DiscardUnknown()

func (*GameServer_Spec_Health) XXX_Marshal Uses

func (m *GameServer_Spec_Health) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GameServer_Spec_Health) XXX_Merge Uses

func (dst *GameServer_Spec_Health) XXX_Merge(src proto.Message)

func (*GameServer_Spec_Health) XXX_Size Uses

func (m *GameServer_Spec_Health) XXX_Size() int

func (*GameServer_Spec_Health) XXX_Unmarshal Uses

func (m *GameServer_Spec_Health) XXX_Unmarshal(b []byte) error

type GameServer_Status Uses

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"`
    Ports                []*GameServer_Status_Port `protobuf:"bytes,3,rep,name=ports,proto3" json:"ports,omitempty"`
    XXX_NoUnkeyedLiteral struct{}                  `json:"-"`
    XXX_unrecognized     []byte                    `json:"-"`
    XXX_sizecache        int32                     `json:"-"`
}

func (*GameServer_Status) Descriptor Uses

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

func (*GameServer_Status) GetAddress Uses

func (m *GameServer_Status) GetAddress() string

func (*GameServer_Status) GetPorts Uses

func (m *GameServer_Status) GetPorts() []*GameServer_Status_Port

func (*GameServer_Status) GetState Uses

func (m *GameServer_Status) GetState() string

func (*GameServer_Status) ProtoMessage Uses

func (*GameServer_Status) ProtoMessage()

func (*GameServer_Status) Reset Uses

func (m *GameServer_Status) Reset()

func (*GameServer_Status) String Uses

func (m *GameServer_Status) String() string

func (*GameServer_Status) XXX_DiscardUnknown Uses

func (m *GameServer_Status) XXX_DiscardUnknown()

func (*GameServer_Status) XXX_Marshal Uses

func (m *GameServer_Status) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GameServer_Status) XXX_Merge Uses

func (dst *GameServer_Status) XXX_Merge(src proto.Message)

func (*GameServer_Status) XXX_Size Uses

func (m *GameServer_Status) XXX_Size() int

func (*GameServer_Status) XXX_Unmarshal Uses

func (m *GameServer_Status) XXX_Unmarshal(b []byte) error

type GameServer_Status_Port Uses

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"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

func (*GameServer_Status_Port) Descriptor Uses

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

func (*GameServer_Status_Port) GetName Uses

func (m *GameServer_Status_Port) GetName() string

func (*GameServer_Status_Port) GetPort Uses

func (m *GameServer_Status_Port) GetPort() int32

func (*GameServer_Status_Port) ProtoMessage Uses

func (*GameServer_Status_Port) ProtoMessage()

func (*GameServer_Status_Port) Reset Uses

func (m *GameServer_Status_Port) Reset()

func (*GameServer_Status_Port) String Uses

func (m *GameServer_Status_Port) String() string

func (*GameServer_Status_Port) XXX_DiscardUnknown Uses

func (m *GameServer_Status_Port) XXX_DiscardUnknown()

func (*GameServer_Status_Port) XXX_Marshal Uses

func (m *GameServer_Status_Port) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*GameServer_Status_Port) XXX_Merge Uses

func (dst *GameServer_Status_Port) XXX_Merge(src proto.Message)

func (*GameServer_Status_Port) XXX_Size Uses

func (m *GameServer_Status_Port) XXX_Size() int

func (*GameServer_Status_Port) XXX_Unmarshal Uses

func (m *GameServer_Status_Port) XXX_Unmarshal(b []byte) error

type KeyValue Uses

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"`
    XXX_NoUnkeyedLiteral struct{} `json:"-"`
    XXX_unrecognized     []byte   `json:"-"`
    XXX_sizecache        int32    `json:"-"`
}

Key, Value entry

func (*KeyValue) Descriptor Uses

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

func (*KeyValue) GetKey Uses

func (m *KeyValue) GetKey() string

func (*KeyValue) GetValue Uses

func (m *KeyValue) GetValue() string

func (*KeyValue) ProtoMessage Uses

func (*KeyValue) ProtoMessage()

func (*KeyValue) Reset Uses

func (m *KeyValue) Reset()

func (*KeyValue) String Uses

func (m *KeyValue) String() string

func (*KeyValue) XXX_DiscardUnknown Uses

func (m *KeyValue) XXX_DiscardUnknown()

func (*KeyValue) XXX_Marshal Uses

func (m *KeyValue) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*KeyValue) XXX_Merge Uses

func (dst *KeyValue) XXX_Merge(src proto.Message)

func (*KeyValue) XXX_Size Uses

func (m *KeyValue) XXX_Size() int

func (*KeyValue) XXX_Unmarshal Uses

func (m *KeyValue) XXX_Unmarshal(b []byte) error

type SDKClient Uses

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://godoc.org/google.golang.org/grpc#ClientConn.NewStream.

func NewSDKClient Uses

func NewSDKClient(cc *grpc.ClientConn) SDKClient

type SDKServer Uses

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.

type SDK_HealthClient Uses

type SDK_HealthClient interface {
    Send(*Empty) error
    CloseAndRecv() (*Empty, error)
    grpc.ClientStream
}

type SDK_HealthServer Uses

type SDK_HealthServer interface {
    SendAndClose(*Empty) error
    Recv() (*Empty, error)
    grpc.ServerStream
}

type SDK_WatchGameServerClient Uses

type SDK_WatchGameServerClient interface {
    Recv() (*GameServer, error)
    grpc.ClientStream
}

type SDK_WatchGameServerServer Uses

type SDK_WatchGameServerServer interface {
    Send(*GameServer) error
    grpc.ServerStream
}

Package sdk imports 13 packages (graph) and is imported by 6 packages. Updated 2019-07-26. Refresh now. Tools for package owners.