ping

Documentation

Overview

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

Contents: - 3 messages

Index

• Constants
• func AllMessages() []api.Message
• type PingFinishedEvent
  • func (*PingFinishedEvent) GetCrcString() string
  • func (*PingFinishedEvent) GetMessageName() string
  • func (*PingFinishedEvent) GetMessageType() api.MessageType
  • func (m *PingFinishedEvent) Marshal(b []byte) ([]byte, error)
  • func (m *PingFinishedEvent) Reset()
  • func (m *PingFinishedEvent) Size() (size int)
  • func (m *PingFinishedEvent) Unmarshal(b []byte) error
• type RPCService
  • func NewServiceClient(conn api.Connection) RPCService
• type WantPingFinishedEvents
  • func (*WantPingFinishedEvents) GetCrcString() string
  • func (*WantPingFinishedEvents) GetMessageName() string
  • func (*WantPingFinishedEvents) GetMessageType() api.MessageType
  • func (m *WantPingFinishedEvents) Marshal(b []byte) ([]byte, error)
  • func (m *WantPingFinishedEvents) Reset()
  • func (m *WantPingFinishedEvents) Size() (size int)
  • func (m *WantPingFinishedEvents) Unmarshal(b []byte) error
• type WantPingFinishedEventsReply
  • func (*WantPingFinishedEventsReply) GetCrcString() string
  • func (*WantPingFinishedEventsReply) GetMessageName() string
  • func (*WantPingFinishedEventsReply) GetMessageType() api.MessageType
  • func (m *WantPingFinishedEventsReply) Marshal(b []byte) ([]byte, error)
  • func (m *WantPingFinishedEventsReply) Reset()
  • func (m *WantPingFinishedEventsReply) Size() (size int)
  • func (m *WantPingFinishedEventsReply) Unmarshal(b []byte) error

Constants

const (
	APIFile    = "ping"
	APIVersion = "0.1.0"
	VersionCrc = 0x97a62a8b
)

Functions

func AllMessages

func AllMessages() []api.Message

Messages returns list of all messages in this module.

Types

type PingFinishedEvent

type PingFinishedEvent struct {
	RequestCount uint32 `binapi:"u32,name=request_count" json:"request_count,omitempty"`
	ReplyCount   uint32 `binapi:"u32,name=reply_count" json:"reply_count,omitempty"`
}

PingFinishedEvent defines message 'ping_finished_event'.

func (*PingFinishedEvent) GetCrcString

func (*PingFinishedEvent) GetCrcString() string

func (*PingFinishedEvent) GetMessageName

func (*PingFinishedEvent) GetMessageName() string

func (*PingFinishedEvent) GetMessageType

func (*PingFinishedEvent) GetMessageType() api.MessageType

func (*PingFinishedEvent) Marshal

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

func (*PingFinishedEvent) Reset

func (m *PingFinishedEvent) Reset()

func (*PingFinishedEvent) Size

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

func (*PingFinishedEvent) Unmarshal

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

type RPCService

type RPCService interface {
	WantPingFinishedEvents(ctx context.Context, in *WantPingFinishedEvents) (*WantPingFinishedEventsReply, error)
}

RPCService defines RPC service ping.

func NewServiceClient

func NewServiceClient(conn api.Connection) RPCService

type WantPingFinishedEvents

type WantPingFinishedEvents struct {
	Address   ip_types.Address               `binapi:"address,name=address" json:"address,omitempty"`
	SwIfIndex interface_types.InterfaceIndex `binapi:"interface_index,name=sw_if_index" json:"sw_if_index,omitempty"`
	Repeat    uint32                         `binapi:"u32,name=repeat,default=1" json:"repeat,omitempty"`
	Interval  float64                        `binapi:"f64,name=interval,default=1" json:"interval,omitempty"`
}

/*

• Copyright (c) 2023 Cisco and/or its affiliates.
• Licensed under the Apache License, Version 2.0 (the "License");
• you may not use this file except in compliance with the License.
• You may obtain a copy of the License at: *
• http://www.apache.org/licenses/LICENSE-2.0 *
• Unless required by applicable law or agreed to in writing, software
• distributed under the License is distributed on an "AS IS" BASIS,
• WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
• See the License for the specific language governing permissions and
• limitations under the License.

WantPingFinishedEvents defines message 'want_ping_finished_events'.

func (*WantPingFinishedEvents) GetCrcString

func (*WantPingFinishedEvents) GetCrcString() string

func (*WantPingFinishedEvents) GetMessageName

func (*WantPingFinishedEvents) GetMessageName() string

func (*WantPingFinishedEvents) GetMessageType

func (*WantPingFinishedEvents) GetMessageType() api.MessageType

func (*WantPingFinishedEvents) Marshal

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

func (*WantPingFinishedEvents) Reset

func (m *WantPingFinishedEvents) Reset()

func (*WantPingFinishedEvents) Size

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

func (*WantPingFinishedEvents) Unmarshal

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

type WantPingFinishedEventsReply

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

WantPingFinishedEventsReply defines message 'want_ping_finished_events_reply'.

func (*WantPingFinishedEventsReply) GetCrcString

func (*WantPingFinishedEventsReply) GetCrcString() string

func (*WantPingFinishedEventsReply) GetMessageName

func (*WantPingFinishedEventsReply) GetMessageName() string

func (*WantPingFinishedEventsReply) GetMessageType

func (*WantPingFinishedEventsReply) GetMessageType() api.MessageType

func (*WantPingFinishedEventsReply) Marshal

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

func (*WantPingFinishedEventsReply) Reset

func (m *WantPingFinishedEventsReply) Reset()

func (*WantPingFinishedEventsReply) Size

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

func (*WantPingFinishedEventsReply) Unmarshal

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