pipe

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: 7 Imported by: 0

Documentation

Overview

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

Contents: - 6 messages

Index

Constants

View Source 
const (
	APIFile    = "pipe"
	APIVersion = "1.0.1"
	VersionCrc = 0xc159134a
)

Variables

This section is empty.

Functions

func AllMessages 

func AllMessages() []api.Message

Messages returns list of all messages in this module.

Types

type PipeCreate 

type PipeCreate struct {
	IsSpecified  bool   `binapi:"bool,name=is_specified" json:"is_specified,omitempty"`
	UserInstance uint32 `binapi:"u32,name=user_instance" json:"user_instance,omitempty"`
}

Initialize a new pipe interface with the given parameters

  • is_specified - if non-0, a specific user_instance is being requested
  • user_instance - requested instance, ~0 => dynamically allocate

PipeCreate defines message 'pipe_create'.

func (*PipeCreate) GetCrcString 

func (*PipeCreate) GetCrcString() string

func (*PipeCreate) GetMessageName 

func (*PipeCreate) GetMessageName() string

func (*PipeCreate) GetMessageType 

func (*PipeCreate) GetMessageType() api.MessageType

func (*PipeCreate) Marshal 

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

func (*PipeCreate) Reset 

func (m *PipeCreate) Reset()

func (*PipeCreate) Size 

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

func (*PipeCreate) Unmarshal 

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

type PipeCreateReply 

type PipeCreateReply 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"`
	PipeSwIfIndex [2]interface_types.InterfaceIndex `binapi:"interface_index[2],name=pipe_sw_if_index" json:"pipe_sw_if_index,omitempty"`
}

Reply for pipe create reply

  • retval - return code
  • sw_if_index - software index allocated for the new pipe parent interface Use the parent interface for link up/down and to delete
  • pipe_sw_if_index - the two SW indicies that form the ends of the pipe.

PipeCreateReply defines message 'pipe_create_reply'.

func (*PipeCreateReply) GetCrcString 

func (*PipeCreateReply) GetCrcString() string

func (*PipeCreateReply) GetMessageName 

func (*PipeCreateReply) GetMessageName() string

func (*PipeCreateReply) GetMessageType 

func (*PipeCreateReply) GetMessageType() api.MessageType

func (*PipeCreateReply) Marshal 

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

func (*PipeCreateReply) Reset 

func (m *PipeCreateReply) Reset()

func (*PipeCreateReply) Size 

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

func (*PipeCreateReply) Unmarshal 

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

type PipeDelete 

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

Delete pipe interface

  • sw_if_index - interface index of existing parent pipe interface

PipeDelete defines message 'pipe_delete'.

func (*PipeDelete) GetCrcString 

func (*PipeDelete) GetCrcString() string

func (*PipeDelete) GetMessageName 

func (*PipeDelete) GetMessageName() string

func (*PipeDelete) GetMessageType 

func (*PipeDelete) GetMessageType() api.MessageType

func (*PipeDelete) Marshal 

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

func (*PipeDelete) Reset 

func (m *PipeDelete) Reset()

func (*PipeDelete) Size 

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

func (*PipeDelete) Unmarshal 

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

type PipeDeleteReply 

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

PipeDeleteReply defines message 'pipe_delete_reply'.

func (*PipeDeleteReply) GetCrcString 

func (*PipeDeleteReply) GetCrcString() string

func (*PipeDeleteReply) GetMessageName 

func (*PipeDeleteReply) GetMessageName() string

func (*PipeDeleteReply) GetMessageType 

func (*PipeDeleteReply) GetMessageType() api.MessageType

func (*PipeDeleteReply) Marshal 

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

func (*PipeDeleteReply) Reset 

func (m *PipeDeleteReply) Reset()

func (*PipeDeleteReply) Size 

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

func (*PipeDeleteReply) Unmarshal 

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

type PipeDetails 

type PipeDetails struct {
	SwIfIndex     interface_types.InterfaceIndex    `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	PipeSwIfIndex [2]interface_types.InterfaceIndex `binapi:"interface_index[2],name=pipe_sw_if_index" json:"pipe_sw_if_index,omitempty"`
	Instance      uint32                            `binapi:"u32,name=instance" json:"instance,omitempty"`
}

Reply for pipe dump request

  • sw_if_index - software index of pipe interface
  • sw_if_index - software index allocated for the pipe parent interface
  • pipe_sw_if_index - the two SW indicies that form the ends of the pipe.
  • instance - instance allocated

PipeDetails defines message 'pipe_details'.

func (*PipeDetails) GetCrcString 

func (*PipeDetails) GetCrcString() string

func (*PipeDetails) GetMessageName 

func (*PipeDetails) GetMessageName() string

func (*PipeDetails) GetMessageType 

func (*PipeDetails) GetMessageType() api.MessageType

func (*PipeDetails) Marshal 

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

func (*PipeDetails) Reset 

func (m *PipeDetails) Reset()

func (*PipeDetails) Size 

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

func (*PipeDetails) Unmarshal 

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

type PipeDump 

type PipeDump struct{}

Dump pipe interfaces request PipeDump defines message 'pipe_dump'.

func (*PipeDump) GetCrcString 

func (*PipeDump) GetCrcString() string

func (*PipeDump) GetMessageName 

func (*PipeDump) GetMessageName() string

func (*PipeDump) GetMessageType 

func (*PipeDump) GetMessageType() api.MessageType

func (*PipeDump) Marshal 

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

func (*PipeDump) Reset 

func (m *PipeDump) Reset()

func (*PipeDump) Size 

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

func (*PipeDump) Unmarshal 

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

type RPCService 

type RPCService interface {
	PipeCreate(ctx context.Context, in *PipeCreate) (*PipeCreateReply, error)
	PipeDelete(ctx context.Context, in *PipeDelete) (*PipeDeleteReply, error)
	PipeDump(ctx context.Context, in *PipeDump) (RPCService_PipeDumpClient, error)
}

RPCService defines RPC service pipe.

func NewServiceClient 

func NewServiceClient(conn api.Connection) RPCService

type RPCService_PipeDumpClient 

type RPCService_PipeDumpClient interface {
	Recv() (*PipeDetails, 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.