jsonapi

Documentation

Overview

Copyright 2024 Louis Royer and the NextMN-json-api contributors. All rights reserved. Use of this source code is governed by a MIT-style license that can be found in the LICENSE file. SPDX-License-Identifier: MIT

Copyright 2024 Louis Royer and the NextMN-json-api contributors. All rights reserved. Use of this source code is governed by a MIT-style license that can be found in the LICENSE file. SPDX-License-Identifier: MIT

Copyright 2024 Louis Royer and the NextMN-json-api contributors. All rights reserved. Use of this source code is governed by a MIT-style license that can be found in the LICENSE file. SPDX-License-Identifier: MIT

Copyright 2024 Louis Royer and the NextMN-json-api contributors. All rights reserved. Use of this source code is governed by a MIT-style license that can be found in the LICENSE file. SPDX-License-Identifier: MIT

Copyright 2024 Louis Royer and the NextMN-json-api contributors. All rights reserved. Use of this source code is governed by a MIT-style license that can be found in the LICENSE file. SPDX-License-Identifier: MIT

Copyright 2024 Louis Royer and the NextMN-json-api contributors. All rights reserved. Use of this source code is governed by a MIT-style license that can be found in the LICENSE file. SPDX-License-Identifier: MIT

Copyright 2024 Louis Royer and the NextMN-json-api contributors. All rights reserved. Use of this source code is governed by a MIT-style license that can be found in the LICENSE file. SPDX-License-Identifier: MIT

Copyright 2024 Louis Royer and the NextMN-json-api contributors. All rights reserved. Use of this source code is governed by a MIT-style license that can be found in the LICENSE file. SPDX-License-Identifier: MIT

Copyright 2024 Louis Royer and the NextMN-json-api contributors. All rights reserved. Use of this source code is governed by a MIT-style license that can be found in the LICENSE file. SPDX-License-Identifier: MIT

Copyright 2024 Louis Royer and the NextMN-json-api contributors. All rights reserved. Use of this source code is governed by a MIT-style license that can be found in the LICENSE file. SPDX-License-Identifier: MIT

Copyright 2024 Louis Royer and the NextMN-json-api contributors. All rights reserved. Use of this source code is governed by a MIT-style license that can be found in the LICENSE file. SPDX-License-Identifier: MIT

Copyright 2024 Louis Royer and the NextMN-json-api contributors. All rights reserved. Use of this source code is governed by a MIT-style license that can be found in the LICENSE file. SPDX-License-Identifier: MIT

Copyright 2024 Louis Royer and the NextMN-json-api contributors. All rights reserved. Use of this source code is governed by a MIT-style license that can be found in the LICENSE file. SPDX-License-Identifier: MIT

Copyright 2024 Louis Royer and the NextMN-json-api contributors. All rights reserved. Use of this source code is governed by a MIT-style license that can be found in the LICENSE file. SPDX-License-Identifier: MIT

Copyright 2024 Louis Royer and the NextMN-json-api contributors. All rights reserved. Use of this source code is governed by a MIT-style license that can be found in the LICENSE file. SPDX-License-Identifier: MIT

Copyright 2024 Louis Royer and the NextMN-json-api contributors. All rights reserved. Use of this source code is governed by a MIT-style license that can be found in the LICENSE file. SPDX-License-Identifier: MIT

Index

• type Action
• type BackboneIP
  • func (b *BackboneIP) UnmarshalText(text []byte) error
• type ControlURI
  • func (u ControlURI) MarshalJSON() ([]byte, error)
  • func (u *ControlURI) UnmarshalText(text []byte) error
• type GtpHeader
• type Locator
  • func (l Locator) Overlaps(o Locator) bool
  • func (l *Locator) UnmarshalText(text []byte) error
• type Match
• type Message
• type MessageWithError
• type NextHop
  • func NewNextHop(nh string) (*NextHop, error)
  • func (nh *NextHop) UnmarshalText(text []byte) error
• type Payload
• type Router
• type RouterMap
• type Rule
• type RuleMap
• type SRH
  • func NewSRH(segments []string) (*SRH, error)
  • func (srh SRH) AsSlice() []net.IP
• type Segment
  • func NewSegment(s string) (*Segment, error)
  • func (s *Segment) UnmarshalText(text []byte) error

Types

type Action

type Action struct {
	SRH SRH `json:"srh"`
}

type BackboneIP

type BackboneIP struct {
	netip.Addr
}

func (*BackboneIP) UnmarshalText

func (b *BackboneIP) UnmarshalText(text []byte) error

type ControlURI

type ControlURI struct {
	url.URL
}

func (ControlURI) MarshalJSON

func (u ControlURI) MarshalJSON() ([]byte, error)

func (*ControlURI) UnmarshalText

func (u *ControlURI) UnmarshalText(text []byte) error

type GtpHeader

type GtpHeader struct {
	OuterIpSrc netip.Addr  `json:"outer-ip-src"` // i.e. gNB ip
	Teid       uint32      `json:"teid"`
	InnerIpSrc *netip.Addr `json:"inner-ip-src,omitempty"` // i.e. UE ip; only useful for uplink when multiple PDU Sessions are aggregated on a single TEID
}

type Locator

type Locator struct {
	netip.Prefix
}

func (Locator) Overlaps

func (l Locator) Overlaps(o Locator) bool

func (*Locator) UnmarshalText

func (l *Locator) UnmarshalText(text []byte) error

type Match

type Match struct {
	Header  *GtpHeader `json:"gtp,omitempty"`
	Payload *Payload   `json:"payload,omitempty"` // if empty, the rule is considered "default"
}

type Message

type Message struct {
	Message string
}

type MessageWithError

type MessageWithError struct {
	Message string
	Error   error
}

type NextHop

type NextHop struct {
	netip.Addr
}

func NewNextHop

func NewNextHop(nh string) (*NextHop, error)

func (*NextHop) UnmarshalText

func (nh *NextHop) UnmarshalText(text []byte) error

type Payload

type Payload struct {
	Dst netip.Addr `json:"destination-ip"`
}

type Router

type Router struct {
	Locator  Locator    `json:"locator"`  // locator (ipv6 prefix)
	Backbone BackboneIP `json:"backbone"` // data plane backbone ipv6 address
	Control  ControlURI `json:"control"`  // url used for control
}

type RouterMap

type RouterMap map[uuid.UUID]Router

type Rule

type Rule struct {
	Enabled bool
	Type    string // uplink or downlink
	Match   Match
	Action  Action
}

type RuleMap

type RuleMap map[uuid.UUID]Rule

type SRH

type SRH []*Segment

func NewSRH

func NewSRH(segments []string) (*SRH, error)

func (SRH) AsSlice

func (srh SRH) AsSlice() []net.IP

type Segment

type Segment struct {
	netip.Addr
}

func NewSegment

func NewSegment(s string) (*Segment, error)

func (*Segment) UnmarshalText

func (s *Segment) UnmarshalText(text []byte) error