pppoe

package
v0.0.1 Latest Latest
Warning

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

 Go to latest Published: May 10, 2024 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Overview

Package pppoe contains generated bindings for API file pppoe.api.

Contents: - 6 messages

Index

Constants

View Source 
const (
	APIFile    = "pppoe"
	APIVersion = "2.0.0"
	VersionCrc = 0xec9e86bf
)

Variables

This section is empty.

Functions

func AllMessages 

func AllMessages() []api.Message

Messages returns list of all messages in this module.

Types

type PppoeAddDelCp 

type PppoeAddDelCp struct {
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	IsAdd     uint8                          `binapi:"u8,name=is_add" json:"is_add,omitempty"`
}

Create PPPOE control plane interface

  • sw_if_index - software index of the interface
  • is_add - to create or to delete

PppoeAddDelCp defines message 'pppoe_add_del_cp'.

func (*PppoeAddDelCp) GetCrcString 

func (*PppoeAddDelCp) GetCrcString() string

func (*PppoeAddDelCp) GetMessageName 

func (*PppoeAddDelCp) GetMessageName() string

func (*PppoeAddDelCp) GetMessageType 

func (*PppoeAddDelCp) GetMessageType() api.MessageType

func (*PppoeAddDelCp) Marshal 

func (m *PppoeAddDelCp) Marshal(b []byte) ([]byte, error)

func (*PppoeAddDelCp) Reset 

func (m *PppoeAddDelCp) Reset()

func (*PppoeAddDelCp) Size 

func (m *PppoeAddDelCp) Size() (size int)

func (*PppoeAddDelCp) Unmarshal 

func (m *PppoeAddDelCp) Unmarshal(b []byte) error

type PppoeAddDelCpReply 

type PppoeAddDelCpReply struct {
	Retval int32 `binapi:"i32,name=retval" json:"retval,omitempty"`
}

reply for create PPPOE control plane interface

  • retval - return code

PppoeAddDelCpReply defines message 'pppoe_add_del_cp_reply'.

func (*PppoeAddDelCpReply) GetCrcString 

func (*PppoeAddDelCpReply) GetCrcString() string

func (*PppoeAddDelCpReply) GetMessageName 

func (*PppoeAddDelCpReply) GetMessageName() string

func (*PppoeAddDelCpReply) GetMessageType 

func (*PppoeAddDelCpReply) GetMessageType() api.MessageType

func (*PppoeAddDelCpReply) Marshal 

func (m *PppoeAddDelCpReply) Marshal(b []byte) ([]byte, error)

func (*PppoeAddDelCpReply) Reset 

func (m *PppoeAddDelCpReply) Reset()

func (*PppoeAddDelCpReply) Size 

func (m *PppoeAddDelCpReply) Size() (size int)

func (*PppoeAddDelCpReply) Unmarshal 

func (m *PppoeAddDelCpReply) Unmarshal(b []byte) error

type PppoeAddDelSession 

type PppoeAddDelSession struct {
	IsAdd      bool                      `binapi:"bool,name=is_add" json:"is_add,omitempty"`
	SessionID  uint16                    `binapi:"u16,name=session_id" json:"session_id,omitempty"`
	ClientIP   ip_types.Address          `binapi:"address,name=client_ip" json:"client_ip,omitempty"`
	DecapVrfID uint32                    `binapi:"u32,name=decap_vrf_id" json:"decap_vrf_id,omitempty"`
	ClientMac  ethernet_types.MacAddress `binapi:"mac_address,name=client_mac" json:"client_mac,omitempty"`
}

Set or delete an PPPOE session

  • is_add - add address if non-zero, else delete
  • session_id - PPPoE session ID
  • client_ip - PPPOE session's client address.
  • decap_vrf_id - the vrf index for pppoe decaped packet
  • client_mac - the client ethernet address

PppoeAddDelSession defines message 'pppoe_add_del_session'.

func (*PppoeAddDelSession) GetCrcString 

func (*PppoeAddDelSession) GetCrcString() string

func (*PppoeAddDelSession) GetMessageName 

func (*PppoeAddDelSession) GetMessageName() string

func (*PppoeAddDelSession) GetMessageType 

func (*PppoeAddDelSession) GetMessageType() api.MessageType

func (*PppoeAddDelSession) Marshal 

func (m *PppoeAddDelSession) Marshal(b []byte) ([]byte, error)

func (*PppoeAddDelSession) Reset 

func (m *PppoeAddDelSession) Reset()

func (*PppoeAddDelSession) Size 

func (m *PppoeAddDelSession) Size() (size int)

func (*PppoeAddDelSession) Unmarshal 

func (m *PppoeAddDelSession) Unmarshal(b []byte) error

type PppoeAddDelSessionReply 

type PppoeAddDelSessionReply struct {
	Retval    int32                          `binapi:"i32,name=retval" json:"retval,omitempty"`
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
}

reply for set or delete an PPPOE session

  • retval - return code
  • sw_if_index - software index of the interface

PppoeAddDelSessionReply defines message 'pppoe_add_del_session_reply'.

func (*PppoeAddDelSessionReply) GetCrcString 

func (*PppoeAddDelSessionReply) GetCrcString() string

func (*PppoeAddDelSessionReply) GetMessageName 

func (*PppoeAddDelSessionReply) GetMessageName() string

func (*PppoeAddDelSessionReply) GetMessageType 

func (*PppoeAddDelSessionReply) GetMessageType() api.MessageType

func (*PppoeAddDelSessionReply) Marshal 

func (m *PppoeAddDelSessionReply) Marshal(b []byte) ([]byte, error)

func (*PppoeAddDelSessionReply) Reset 

func (m *PppoeAddDelSessionReply) Reset()

func (*PppoeAddDelSessionReply) Size 

func (m *PppoeAddDelSessionReply) Size() (size int)

func (*PppoeAddDelSessionReply) Unmarshal 

func (m *PppoeAddDelSessionReply) Unmarshal(b []byte) error

type PppoeSessionDetails 

type PppoeSessionDetails struct {
	SwIfIndex    interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	SessionID    uint16                         `binapi:"u16,name=session_id" json:"session_id,omitempty"`
	ClientIP     ip_types.Address               `binapi:"address,name=client_ip" json:"client_ip,omitempty"`
	EncapIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=encap_if_index" json:"encap_if_index,omitempty"`
	DecapVrfID   uint32                         `binapi:"u32,name=decap_vrf_id" json:"decap_vrf_id,omitempty"`
	LocalMac     ethernet_types.MacAddress      `binapi:"mac_address,name=local_mac" json:"local_mac,omitempty"`
	ClientMac    ethernet_types.MacAddress      `binapi:"mac_address,name=client_mac" json:"client_mac,omitempty"`
}

dump details of an PPPOE session

  • sw_if_index - software index of the interface
  • session_id - PPPoE session ID
  • client_ip - PPPOE session's client address.
  • encap_if_index - the index of tx interface for pppoe encaped packet
  • decap_vrf_id - the vrf index for pppoe decaped packet
  • local_mac - the local ethernet address
  • client_mac - the client ethernet address

PppoeSessionDetails defines message 'pppoe_session_details'.

func (*PppoeSessionDetails) GetCrcString 

func (*PppoeSessionDetails) GetCrcString() string

func (*PppoeSessionDetails) GetMessageName 

func (*PppoeSessionDetails) GetMessageName() string

func (*PppoeSessionDetails) GetMessageType 

func (*PppoeSessionDetails) GetMessageType() api.MessageType

func (*PppoeSessionDetails) Marshal 

func (m *PppoeSessionDetails) Marshal(b []byte) ([]byte, error)

func (*PppoeSessionDetails) Reset 

func (m *PppoeSessionDetails) Reset()

func (*PppoeSessionDetails) Size 

func (m *PppoeSessionDetails) Size() (size int)

func (*PppoeSessionDetails) Unmarshal 

func (m *PppoeSessionDetails) Unmarshal(b []byte) error

type PppoeSessionDump 

type PppoeSessionDump struct {
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
}

Dump PPPOE session

  • sw_if_index - software index of the interface

PppoeSessionDump defines message 'pppoe_session_dump'.

func (*PppoeSessionDump) GetCrcString 

func (*PppoeSessionDump) GetCrcString() string

func (*PppoeSessionDump) GetMessageName 

func (*PppoeSessionDump) GetMessageName() string

func (*PppoeSessionDump) GetMessageType 

func (*PppoeSessionDump) GetMessageType() api.MessageType

func (*PppoeSessionDump) Marshal 

func (m *PppoeSessionDump) Marshal(b []byte) ([]byte, error)

func (*PppoeSessionDump) Reset 

func (m *PppoeSessionDump) Reset()

func (*PppoeSessionDump) Size 

func (m *PppoeSessionDump) Size() (size int)

func (*PppoeSessionDump) Unmarshal 

func (m *PppoeSessionDump) Unmarshal(b []byte) error

type RPCService 

type RPCService interface {
	PppoeAddDelCp(ctx context.Context, in *PppoeAddDelCp) (*PppoeAddDelCpReply, error)
	PppoeAddDelSession(ctx context.Context, in *PppoeAddDelSession) (*PppoeAddDelSessionReply, error)
	PppoeSessionDump(ctx context.Context, in *PppoeSessionDump) (RPCService_PppoeSessionDumpClient, error)
}

RPCService defines RPC service pppoe.

func NewServiceClient 

func NewServiceClient(conn api.Connection) RPCService

type RPCService_PppoeSessionDumpClient 

type RPCService_PppoeSessionDumpClient interface {
	Recv() (*PppoeSessionDetails, error)
	api.Stream
}

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.
JackTT - Gopher 🇻🇳