Documentation
¶
Index ¶
- type Broadcast
- type BroadcastClient
- type CancelLocationStatusCode
- type Client
- type CypherResponseStatusCode
- type DetermineLocationStatusCode
- type Location
- type LocationClient
- func (l LocationClient) CancelLocation(ctx context.Context) nlmfocation.ApiCancelLocationRequest
- func (l LocationClient) CancelLocationExecute(r nlmfocation.ApiCancelLocationRequest) (*http.Response, error)
- func (l LocationClient) DetermineLocation(ctx context.Context) nlmfocation.ApiDetermineLocationRequest
- func (l LocationClient) DetermineLocationExecute(r nlmfocation.ApiDetermineLocationRequest) (*nlmfocation.LocationData, *http.Response, error)
- func (l LocationClient) LocationContextTransfer(ctx context.Context) nlmfocation.ApiLocationContextTransferRequest
- func (l LocationClient) LocationContextTransferExecute(r nlmfocation.ApiLocationContextTransferRequest) (*http.Response, error)
- type LocationContextTransferStatusCode
- type Server
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Broadcast ¶
type Broadcast interface {
fivegc.CommonInterface
CipherKeyData(context.Context, openapinlmfbroadcast.CipherRequestData) (openapinlmfbroadcast.CipherResponseData, openapicommon.ProblemDetails, fivegc.RedirectResponse, CypherResponseStatusCode)
}
Broadcast is the interface that wraps the NLMF Broadcast service.
type BroadcastClient ¶
type BroadcastClient struct {
// contains filtered or unexported fields
}
BroadcastClient is a client for the NLMF Broadcast service.
func NewBroadcastClient ¶
func NewBroadcastClient(cfg fivegc.ClientConfiguration) *BroadcastClient
NewBroadcastClient creates a new client for the NLMF Broadcast service.
func (*BroadcastClient) CipheringKeyData ¶
func (c *BroadcastClient) CipheringKeyData(ctx context.Context) openapinlmfbroadcast.ApiCipheringKeyDataRequest
CipheringKeyData returns a cipher request.
func (*BroadcastClient) CipheringKeyDataExecute ¶
func (c *BroadcastClient) CipheringKeyDataExecute(r openapinlmfbroadcast.ApiCipheringKeyDataRequest) (*openapinlmfbroadcast.CipherResponseData, error)
CipheringKeyDataExecute executes a cipher request.
type CancelLocationStatusCode ¶
type CancelLocationStatusCode fivegc.StatusCode
const ( // CancelLocationStatusNoContent is the status code for the response when the location request is successfully cancelled. CancelLocationStatusNoContent CancelLocationStatusCode = CancelLocationStatusCode(fivegc.StatusNoContent) CancelLocationStatusTemporaryRedirect CancelLocationStatusCode = CancelLocationStatusCode(fivegc.StatusTemporaryRedirect) CancelLocationStatusPermanentRedirect CancelLocationStatusCode = CancelLocationStatusCode(fivegc.StatusPermanentRedirect) )
type Client ¶
type Client struct {
*BroadcastClient
*LocationClient
}
func NewClient ¶
func NewClient(config fivegc.ClientConfiguration) *Client
NewClient returns a new client for an NLMF service.
type CypherResponseStatusCode ¶
type CypherResponseStatusCode fivegc.StatusCode
const ( // CypherResponseStatusCodeOK is the status code for a successful response. CypherResponseStatusCodeOK CypherResponseStatusCode = CypherResponseStatusCode(fivegc.StatusOK) CypherResponseStatusTemporaryRedirect CypherResponseStatusCode = CypherResponseStatusCode(fivegc.StatusTemporaryRedirect) CypherResponseStatusPermanentRedirect CypherResponseStatusCode = CypherResponseStatusCode(fivegc.StatusPermanentRedirect) )
type DetermineLocationStatusCode ¶
type DetermineLocationStatusCode fivegc.StatusCode
const ( // DetermineLocationStatusOK is the status code for a successful response. DetermineLocationStatusOK DetermineLocationStatusCode = DetermineLocationStatusCode(fivegc.StatusOK) DetermineLocationStatusNoContent DetermineLocationStatusCode = DetermineLocationStatusCode(fivegc.StatusNoContent) DetermineLocationStatusTemporaryRedirect DetermineLocationStatusCode = DetermineLocationStatusCode(fivegc.StatusTemporaryRedirect) DetermineLocationStatusPermanentRedirect DetermineLocationStatusCode = DetermineLocationStatusCode(fivegc.StatusPermanentRedirect) )
type Location ¶
type Location interface {
fivegc.CommonInterface
// CancelLocation cancels a location request.
CancelLocation(context.Context, nlmfocation.CancelLocData) (openapicommon.ProblemDetails, fivegc.RedirectResponse, CancelLocationStatusCode)
// DetermineLocation determines the location of a UE.
DetermineLocation(context.Context, nlmfocation.InputData) (nlmfocation.LocationData, openapicommon.ProblemDetails, fivegc.RedirectResponse, DetermineLocationStatusCode)
// LocationContextTransfer transfers the location context of a UE.
LocationContextTransfer(context.Context, nlmfocation.LocContextData) (openapicommon.ProblemDetails, fivegc.RedirectResponse, LocationContextTransferStatusCode)
}
type LocationClient ¶
type LocationClient struct {
// contains filtered or unexported fields
}
LocationClient is a client for the NLMF Location service.
func NewLocationClient ¶
func NewLocationClient(cfg fivegc.ClientConfiguration) *LocationClient
NewLocationClient creates a new client for the NLMF Location service.
func (LocationClient) CancelLocation ¶
func (l LocationClient) CancelLocation(ctx context.Context) nlmfocation.ApiCancelLocationRequest
CancelLocation returns cancel location request
func (LocationClient) CancelLocationExecute ¶
func (l LocationClient) CancelLocationExecute(r nlmfocation.ApiCancelLocationRequest) (*http.Response, error)
CancelLocationExecute executes the cancel location request
func (LocationClient) DetermineLocation ¶
func (l LocationClient) DetermineLocation(ctx context.Context) nlmfocation.ApiDetermineLocationRequest
DetermineLocation returns determine location request
func (LocationClient) DetermineLocationExecute ¶
func (l LocationClient) DetermineLocationExecute(r nlmfocation.ApiDetermineLocationRequest) (*nlmfocation.LocationData, *http.Response, error)
DetermineLocationExecute executes the determine location request
func (LocationClient) LocationContextTransfer ¶
func (l LocationClient) LocationContextTransfer(ctx context.Context) nlmfocation.ApiLocationContextTransferRequest
LocationContextTransfer returns location context transfer request
func (LocationClient) LocationContextTransferExecute ¶
func (l LocationClient) LocationContextTransferExecute(r nlmfocation.ApiLocationContextTransferRequest) (*http.Response, error)
LocationContextTransferExecute executes the location context transfer request
type LocationContextTransferStatusCode ¶
type LocationContextTransferStatusCode fivegc.StatusCode
const ( // LocationContextTransferStatusNoContent is the status code for the response when the location context transfer is successful. LocationContextTransferStatusNoContent LocationContextTransferStatusCode = LocationContextTransferStatusCode(fivegc.StatusNoContent) LocationContextTransferStatusTemporaryRedirect LocationContextTransferStatusCode = LocationContextTransferStatusCode(fivegc.StatusTemporaryRedirect) LocationContextTransferStatusPermanentRedirect LocationContextTransferStatusCode = LocationContextTransferStatusCode(fivegc.StatusPermanentRedirect) )
type Server ¶
type Server struct {
// contains filtered or unexported fields
}
Server represents a NLMF server.
func NewServer ¶
NewServer creates a new Server NLMF server instance. The address is the IP:PORT of the NLMF server.
func (*Server) AttachBroadcast ¶
AttachBroadcast attaches a Broadcast handler to the NLMF Server.
func (*Server) AttachLocation ¶
AttachLocation attaches a Location handler to the NLMF Server.