public

package
v0.1.0-alpha.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Aug 9, 2023 License: MIT Imports: 15 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Client 

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

Client for public API

func (*Client) ListServer deprecated 

func (a *Client) ListServer(params *ListServerParams, authInfo runtime.ClientAuthInfoWriter) (*ListServerOK, *ListServerInternalServerError, error)

Deprecated: 2022-08-10 - Use ListServerShort instead.

ListServer get list of qos services ``` This endpoint lists all QoS services available in all regions.

This endpoint is intended to be called by game client to find out all available regions. After getting a list of QoS on each region, game client is expected to ping each one with UDP connection as described below:

1. Make UDP connection to each QoS's IP:Port 2. Send string "PING" after connection established 3. Wait for string "PONG" response 4. Note the request-response latency for each QoS in each region

The game then can use ping latency information to either: 1. Inform the player on these latencies and let player choose preferred region 2. Send the latency list to Matchmaking Service so that player can be matched with other players in nearby regions ```

func (*Client) ListServerPerNamespace deprecated 

func (a *Client) ListServerPerNamespace(params *ListServerPerNamespaceParams, authInfo runtime.ClientAuthInfoWriter) (*ListServerPerNamespaceOK, *ListServerPerNamespaceInternalServerError, error)

Deprecated: 2022-08-10 - Use ListServerPerNamespaceShort instead.

ListServerPerNamespace get list of qos services per region ``` This endpoint lists all QoS services available in all regions.

This endpoint is intended to be called by game client to find out all available regions. After getting a list of QoS on each region, game client is expected to ping each one with UDP connection as described below:

1. Make UDP connection to each QoS's IP:Port 2. Send string "PING" after connection established 3. Wait for string "PONG" response 4. Note the request-response latency for each QoS in each region

The game then can use ping latency information to either: 1. Inform the player on these latencies and let player choose preferred region 2. Send the latency list to Matchmaking Service so that player can be matched with other players in nearby regions ```

func (*Client) ListServerPerNamespaceShort 

func (a *Client) ListServerPerNamespaceShort(params *ListServerPerNamespaceParams, authInfo runtime.ClientAuthInfoWriter) (*ListServerPerNamespaceOK, error)

ListServerPerNamespaceShort get list of qos services per region ``` This endpoint lists all QoS services available in all regions.

This endpoint is intended to be called by game client to find out all available regions. After getting a list of QoS on each region, game client is expected to ping each one with UDP connection as described below:

1. Make UDP connection to each QoS's IP:Port 2. Send string "PING" after connection established 3. Wait for string "PONG" response 4. Note the request-response latency for each QoS in each region

The game then can use ping latency information to either: 1. Inform the player on these latencies and let player choose preferred region 2. Send the latency list to Matchmaking Service so that player can be matched with other players in nearby regions ```

func (*Client) ListServerShort 

func (a *Client) ListServerShort(params *ListServerParams, authInfo runtime.ClientAuthInfoWriter) (*ListServerOK, error)

ListServerShort get list of qos services ``` This endpoint lists all QoS services available in all regions.

This endpoint is intended to be called by game client to find out all available regions. After getting a list of QoS on each region, game client is expected to ping each one with UDP connection as described below:

1. Make UDP connection to each QoS's IP:Port 2. Send string "PING" after connection established 3. Wait for string "PONG" response 4. Note the request-response latency for each QoS in each region

The game then can use ping latency information to either: 1. Inform the player on these latencies and let player choose preferred region 2. Send the latency list to Matchmaking Service so that player can be matched with other players in nearby regions ```

func (*Client) SetTransport 

func (a *Client) SetTransport(transport runtime.ClientTransport)

SetTransport changes the transport on the client

type ClientService 

type ClientService interface {
	ListServerPerNamespace(params *ListServerPerNamespaceParams, authInfo runtime.ClientAuthInfoWriter) (*ListServerPerNamespaceOK, *ListServerPerNamespaceInternalServerError, error)
	ListServerPerNamespaceShort(params *ListServerPerNamespaceParams, authInfo runtime.ClientAuthInfoWriter) (*ListServerPerNamespaceOK, error)
	ListServer(params *ListServerParams, authInfo runtime.ClientAuthInfoWriter) (*ListServerOK, *ListServerInternalServerError, error)
	ListServerShort(params *ListServerParams, authInfo runtime.ClientAuthInfoWriter) (*ListServerOK, error)

	SetTransport(transport runtime.ClientTransport)
}

ClientService is the interface for Client methods

func New 

func New(transport runtime.ClientTransport, formats strfmt.Registry) ClientService

New creates a new public API client.

type ListServerInternalServerError 

type ListServerInternalServerError struct {
	Payload *qosmclientmodels.ResponseError
}

ListServerInternalServerError handles this case with default header values. 

Internal Server Error

func NewListServerInternalServerError 

func NewListServerInternalServerError() *ListServerInternalServerError

NewListServerInternalServerError creates a ListServerInternalServerError with default headers values

func (*ListServerInternalServerError) Error 

func (o *ListServerInternalServerError) Error() string

func (*ListServerInternalServerError) GetPayload 

func (o *ListServerInternalServerError) GetPayload() *qosmclientmodels.ResponseError

func (*ListServerInternalServerError) ToJSONString 

func (o *ListServerInternalServerError) ToJSONString() string

type ListServerOK 

type ListServerOK struct {
	Payload *qosmclientmodels.ModelsListServerResponse
}

ListServerOK handles this case with default header values. 

list of QoS services returned

func NewListServerOK 

func NewListServerOK() *ListServerOK

NewListServerOK creates a ListServerOK with default headers values

func (*ListServerOK) Error 

func (o *ListServerOK) Error() string

func (*ListServerOK) GetPayload 

func (o *ListServerOK) GetPayload() *qosmclientmodels.ModelsListServerResponse

func (*ListServerOK) ToJSONString 

func (o *ListServerOK) ToJSONString() string

type ListServerParams 

type ListServerParams struct {

	/*RetryPolicy*/
	RetryPolicy *utils.Retry

	AuthInfoWriter runtime.ClientAuthInfoWriter
	Context        context.Context
	HTTPClient     *http.Client
	// contains filtered or unexported fields
}

ListServerParams contains all the parameters to send to the API endpoint for the list server operation typically these are written to a http.Request

func NewListServerParams 

func NewListServerParams() *ListServerParams

NewListServerParams creates a new ListServerParams object with the default values initialized.

func NewListServerParamsWithContext 

func NewListServerParamsWithContext(ctx context.Context) *ListServerParams

NewListServerParamsWithContext creates a new ListServerParams object with the default values initialized, and the ability to set a context for a request

func NewListServerParamsWithHTTPClient 

func NewListServerParamsWithHTTPClient(client *http.Client) *ListServerParams

NewListServerParamsWithHTTPClient creates a new ListServerParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewListServerParamsWithTimeout 

func NewListServerParamsWithTimeout(timeout time.Duration) *ListServerParams

NewListServerParamsWithTimeout creates a new ListServerParams object with the default values initialized, and the ability to set a timeout on a request

func (*ListServerParams) SetAuthInfoWriter 

func (o *ListServerParams) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)

SetAuthInfoWriter adds the authInfoWriter to the list server params

func (*ListServerParams) SetContext 

func (o *ListServerParams) SetContext(ctx context.Context)

SetContext adds the context to the list server params

func (*ListServerParams) SetHTTPClient 

func (o *ListServerParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the list server params

func (*ListServerParams) SetHTTPClientTransport 

func (o *ListServerParams) SetHTTPClientTransport(roundTripper http.RoundTripper)

SetHTTPClient adds the HTTPClient Transport to the list server params

func (*ListServerParams) SetTimeout 

func (o *ListServerParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the list server params

func (*ListServerParams) WithContext 

func (o *ListServerParams) WithContext(ctx context.Context) *ListServerParams

WithContext adds the context to the list server params

func (*ListServerParams) WithHTTPClient 

func (o *ListServerParams) WithHTTPClient(client *http.Client) *ListServerParams

WithHTTPClient adds the HTTPClient to the list server params

func (*ListServerParams) WithTimeout 

func (o *ListServerParams) WithTimeout(timeout time.Duration) *ListServerParams

WithTimeout adds the timeout to the list server params

func (*ListServerParams) WriteToRequest 

func (o *ListServerParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type ListServerPerNamespaceInternalServerError 

type ListServerPerNamespaceInternalServerError struct {
	Payload *qosmclientmodels.ResponseError
}

ListServerPerNamespaceInternalServerError handles this case with default header values. 

Internal Server Error

func NewListServerPerNamespaceInternalServerError 

func NewListServerPerNamespaceInternalServerError() *ListServerPerNamespaceInternalServerError

NewListServerPerNamespaceInternalServerError creates a ListServerPerNamespaceInternalServerError with default headers values

func (*ListServerPerNamespaceInternalServerError) Error 

func (o *ListServerPerNamespaceInternalServerError) Error() string

func (*ListServerPerNamespaceInternalServerError) GetPayload 

func (o *ListServerPerNamespaceInternalServerError) GetPayload() *qosmclientmodels.ResponseError

func (*ListServerPerNamespaceInternalServerError) ToJSONString 

func (o *ListServerPerNamespaceInternalServerError) ToJSONString() string

type ListServerPerNamespaceOK 

type ListServerPerNamespaceOK struct {
	Payload *qosmclientmodels.ModelsListServerResponse
}

ListServerPerNamespaceOK handles this case with default header values. 

list of QoS services returned

func NewListServerPerNamespaceOK 

func NewListServerPerNamespaceOK() *ListServerPerNamespaceOK

NewListServerPerNamespaceOK creates a ListServerPerNamespaceOK with default headers values

func (*ListServerPerNamespaceOK) Error 

func (o *ListServerPerNamespaceOK) Error() string

func (*ListServerPerNamespaceOK) GetPayload 

func (o *ListServerPerNamespaceOK) GetPayload() *qosmclientmodels.ModelsListServerResponse

func (*ListServerPerNamespaceOK) ToJSONString 

func (o *ListServerPerNamespaceOK) ToJSONString() string

type ListServerPerNamespaceParams 

type ListServerPerNamespaceParams struct {

	/*RetryPolicy*/
	RetryPolicy *utils.Retry
	/*Namespace
	  namespace of the QoS

	*/
	Namespace string
	/*Status
	  QoS status, available value: ACTIVE, INACTIVE, UNREACHABLE

	*/
	Status *string

	AuthInfoWriter runtime.ClientAuthInfoWriter
	Context        context.Context
	HTTPClient     *http.Client
	// contains filtered or unexported fields
}

ListServerPerNamespaceParams contains all the parameters to send to the API endpoint for the list server per namespace operation typically these are written to a http.Request

func NewListServerPerNamespaceParams 

func NewListServerPerNamespaceParams() *ListServerPerNamespaceParams

NewListServerPerNamespaceParams creates a new ListServerPerNamespaceParams object with the default values initialized.

func NewListServerPerNamespaceParamsWithContext 

func NewListServerPerNamespaceParamsWithContext(ctx context.Context) *ListServerPerNamespaceParams

NewListServerPerNamespaceParamsWithContext creates a new ListServerPerNamespaceParams object with the default values initialized, and the ability to set a context for a request

func NewListServerPerNamespaceParamsWithHTTPClient 

func NewListServerPerNamespaceParamsWithHTTPClient(client *http.Client) *ListServerPerNamespaceParams

NewListServerPerNamespaceParamsWithHTTPClient creates a new ListServerPerNamespaceParams object with the default values initialized, and the ability to set a custom HTTPClient for a request

func NewListServerPerNamespaceParamsWithTimeout 

func NewListServerPerNamespaceParamsWithTimeout(timeout time.Duration) *ListServerPerNamespaceParams

NewListServerPerNamespaceParamsWithTimeout creates a new ListServerPerNamespaceParams object with the default values initialized, and the ability to set a timeout on a request

func (*ListServerPerNamespaceParams) SetAuthInfoWriter 

func (o *ListServerPerNamespaceParams) SetAuthInfoWriter(authInfoWriter runtime.ClientAuthInfoWriter)

SetAuthInfoWriter adds the authInfoWriter to the list server per namespace params

func (*ListServerPerNamespaceParams) SetContext 

func (o *ListServerPerNamespaceParams) SetContext(ctx context.Context)

SetContext adds the context to the list server per namespace params

func (*ListServerPerNamespaceParams) SetHTTPClient 

func (o *ListServerPerNamespaceParams) SetHTTPClient(client *http.Client)

SetHTTPClient adds the HTTPClient to the list server per namespace params

func (*ListServerPerNamespaceParams) SetHTTPClientTransport 

func (o *ListServerPerNamespaceParams) SetHTTPClientTransport(roundTripper http.RoundTripper)

SetHTTPClient adds the HTTPClient Transport to the list server per namespace params

func (*ListServerPerNamespaceParams) SetNamespace 

func (o *ListServerPerNamespaceParams) SetNamespace(namespace string)

SetNamespace adds the namespace to the list server per namespace params

func (*ListServerPerNamespaceParams) SetStatus 

func (o *ListServerPerNamespaceParams) SetStatus(status *string)

SetStatus adds the status to the list server per namespace params

func (*ListServerPerNamespaceParams) SetTimeout 

func (o *ListServerPerNamespaceParams) SetTimeout(timeout time.Duration)

SetTimeout adds the timeout to the list server per namespace params

func (*ListServerPerNamespaceParams) WithContext 

func (o *ListServerPerNamespaceParams) WithContext(ctx context.Context) *ListServerPerNamespaceParams

WithContext adds the context to the list server per namespace params

func (*ListServerPerNamespaceParams) WithHTTPClient 

func (o *ListServerPerNamespaceParams) WithHTTPClient(client *http.Client) *ListServerPerNamespaceParams

WithHTTPClient adds the HTTPClient to the list server per namespace params

func (*ListServerPerNamespaceParams) WithNamespace 

func (o *ListServerPerNamespaceParams) WithNamespace(namespace string) *ListServerPerNamespaceParams

WithNamespace adds the namespace to the list server per namespace params

func (*ListServerPerNamespaceParams) WithStatus 

func (o *ListServerPerNamespaceParams) WithStatus(status *string) *ListServerPerNamespaceParams

WithStatus adds the status to the list server per namespace params

func (*ListServerPerNamespaceParams) WithTimeout 

func (o *ListServerPerNamespaceParams) WithTimeout(timeout time.Duration) *ListServerPerNamespaceParams

WithTimeout adds the timeout to the list server per namespace params

func (*ListServerPerNamespaceParams) WriteToRequest 

func (o *ListServerPerNamespaceParams) WriteToRequest(r runtime.ClientRequest, reg strfmt.Registry) error

WriteToRequest writes these params to a swagger request

type ListServerPerNamespaceReader 

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

ListServerPerNamespaceReader is a Reader for the ListServerPerNamespace structure.

func (*ListServerPerNamespaceReader) ReadResponse 

func (o *ListServerPerNamespaceReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

type ListServerReader 

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

ListServerReader is a Reader for the ListServer structure.

func (*ListServerReader) ReadResponse 

func (o *ListServerReader) ReadResponse(response runtime.ClientResponse, consumer runtime.Consumer) (interface{}, error)

ReadResponse reads a server response into the received o.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.