package pb

Import Path
	github.com/libp2p/go-libp2p/p2p/protocol/circuitv2/pb (on go.dev)

Dependency Relation
	imports 5 packages, and imported by 5 packages

Involved Source Files

	    circuit.pb.go
	    voucher.pb.go
Package-Level Type Names (total 9)

	/* sort by: alphabet | popularity */
	 type HopMessage (struct)

		Fields (total 5)
			Limit *Limit
			Peer *Peer
			Reservation *Reservation
			Status *Status
			Type *HopMessage_Type
				This field is marked optional for backwards compatibility with proto2.
				Users should make sure to always set this.

		Methods (total 10)
			(*HopMessage) Descriptor() ([]byte, []int)
				Deprecated: Use HopMessage.ProtoReflect.Descriptor instead.

			(*HopMessage) GetLimit() *Limit
			(*HopMessage) GetPeer() *Peer
			(*HopMessage) GetReservation() *Reservation
			(*HopMessage) GetStatus() Status
			(*HopMessage) GetType() HopMessage_Type
			(*HopMessage) ProtoMessage()
			(*HopMessage) ProtoReflect() protoreflect.Message
			(*HopMessage) Reset()
			(*HopMessage) String() string
		Implements (at least 5)
			*HopMessage : github.com/gogo/protobuf/proto.Message
			*HopMessage : expvar.Var
			*HopMessage : fmt.Stringer
			*HopMessage : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*HopMessage : google.golang.org/protobuf/runtime/protoiface.MessageV1

	 type HopMessage_Type int32 (basic type)

		Methods (total 6)
			( HopMessage_Type) Descriptor() protoreflect.EnumDescriptor
			( HopMessage_Type) Enum() *HopMessage_Type
			( HopMessage_Type) EnumDescriptor() ([]byte, []int)
				Deprecated: Use HopMessage_Type.Descriptor instead.

			( HopMessage_Type) Number() protoreflect.EnumNumber
			( HopMessage_Type) String() string
			( HopMessage_Type) Type() protoreflect.EnumType
		Implements (at least 3)
			 HopMessage_Type : expvar.Var
			 HopMessage_Type : fmt.Stringer
			 HopMessage_Type : google.golang.org/protobuf/reflect/protoreflect.Enum
		As Outputs Of (at least 2)
			func (*HopMessage).GetType() HopMessage_Type
			func HopMessage_Type.Enum() *HopMessage_Type
		As Types Of (total 3)
			const HopMessage_CONNECT
			const HopMessage_RESERVE
			const HopMessage_STATUS

	 type Limit (struct)

		Fields (total 2)
			Data *uint64
				// bytes

			Duration *uint32
				// seconds

		Methods (total 7)
			(*Limit) Descriptor() ([]byte, []int)
				Deprecated: Use Limit.ProtoReflect.Descriptor instead.

			(*Limit) GetData() uint64
			(*Limit) GetDuration() uint32
			(*Limit) ProtoMessage()
			(*Limit) ProtoReflect() protoreflect.Message
			(*Limit) Reset()
			(*Limit) String() string
		Implements (at least 5)
			*Limit : github.com/gogo/protobuf/proto.Message
			*Limit : expvar.Var
			*Limit : fmt.Stringer
			*Limit : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*Limit : google.golang.org/protobuf/runtime/protoiface.MessageV1
		As Outputs Of (at least 2)
			func (*HopMessage).GetLimit() *Limit
			func (*StopMessage).GetLimit() *Limit

	 type Peer (struct)

		Fields (total 2)
			Addrs [][]byte
			Id []byte
				This field is marked optional for backwards compatibility with proto2.
				Users should make sure to always set this.

		Methods (total 7)
			(*Peer) Descriptor() ([]byte, []int)
				Deprecated: Use Peer.ProtoReflect.Descriptor instead.

			(*Peer) GetAddrs() [][]byte
			(*Peer) GetId() []byte
			(*Peer) ProtoMessage()
			(*Peer) ProtoReflect() protoreflect.Message
			(*Peer) Reset()
			(*Peer) String() string
		Implements (at least 5)
			*Peer : github.com/gogo/protobuf/proto.Message
			*Peer : expvar.Var
			*Peer : fmt.Stringer
			*Peer : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*Peer : google.golang.org/protobuf/runtime/protoiface.MessageV1
		As Outputs Of (at least 3)
			func (*HopMessage).GetPeer() *Peer
			func (*StopMessage).GetPeer() *Peer
			func github.com/libp2p/go-libp2p/p2p/protocol/circuitv2/util.PeerInfoToPeerV2(pi peer.AddrInfo) *Peer
		As Inputs Of (at least one exported)
			func github.com/libp2p/go-libp2p/p2p/protocol/circuitv2/util.PeerToPeerInfoV2(p *Peer) (peer.AddrInfo, error)

	 type Reservation (struct)

		Fields (total 3)
			Addrs [][]byte
				// relay addrs for reserving peer

			Expire *uint64
				This field is marked optional for backwards compatibility with proto2.
				Users should make sure to always set this.
				// Unix expiration time (UTC)

			Voucher []byte
				// reservation voucher

		Methods (total 8)
			(*Reservation) Descriptor() ([]byte, []int)
				Deprecated: Use Reservation.ProtoReflect.Descriptor instead.

			(*Reservation) GetAddrs() [][]byte
			(*Reservation) GetExpire() uint64
			(*Reservation) GetVoucher() []byte
			(*Reservation) ProtoMessage()
			(*Reservation) ProtoReflect() protoreflect.Message
			(*Reservation) Reset()
			(*Reservation) String() string
		Implements (at least 5)
			*Reservation : github.com/gogo/protobuf/proto.Message
			*Reservation : expvar.Var
			*Reservation : fmt.Stringer
			*Reservation : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*Reservation : google.golang.org/protobuf/runtime/protoiface.MessageV1
		As Outputs Of (at least one exported)
			func (*HopMessage).GetReservation() *Reservation

	 type ReservationVoucher (struct)

		Fields (total 3)
			Expiration *uint64
			Peer []byte
			Relay []byte
				These fields are marked optional for backwards compatibility with proto2.
				Users should make sure to always set these.

		Methods (total 8)
			(*ReservationVoucher) Descriptor() ([]byte, []int)
				Deprecated: Use ReservationVoucher.ProtoReflect.Descriptor instead.

			(*ReservationVoucher) GetExpiration() uint64
			(*ReservationVoucher) GetPeer() []byte
			(*ReservationVoucher) GetRelay() []byte
			(*ReservationVoucher) ProtoMessage()
			(*ReservationVoucher) ProtoReflect() protoreflect.Message
			(*ReservationVoucher) Reset()
			(*ReservationVoucher) String() string
		Implements (at least 5)
			*ReservationVoucher : github.com/gogo/protobuf/proto.Message
			*ReservationVoucher : expvar.Var
			*ReservationVoucher : fmt.Stringer
			*ReservationVoucher : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*ReservationVoucher : google.golang.org/protobuf/runtime/protoiface.MessageV1

	 type Status int32 (basic type)

		Methods (total 6)
			( Status) Descriptor() protoreflect.EnumDescriptor
			( Status) Enum() *Status
			( Status) EnumDescriptor() ([]byte, []int)
				Deprecated: Use Status.Descriptor instead.

			( Status) Number() protoreflect.EnumNumber
			( Status) String() string
			( Status) Type() protoreflect.EnumType
		Implements (at least 3)
			 Status : expvar.Var
			 Status : fmt.Stringer
			 Status : google.golang.org/protobuf/reflect/protoreflect.Enum
		As Outputs Of (at least 3)
			func (*HopMessage).GetStatus() Status
			func Status.Enum() *Status
			func (*StopMessage).GetStatus() Status
		As Inputs Of (at least 2)
			func github.com/libp2p/go-libp2p/p2p/protocol/circuitv2/relay.MetricsTracer.ConnectionRequestHandled(status Status)
			func github.com/libp2p/go-libp2p/p2p/protocol/circuitv2/relay.MetricsTracer.ReservationRequestHandled(status Status)
		As Types Of (total 9)
			const Status_CONNECTION_FAILED
			const Status_MALFORMED_MESSAGE
			const Status_NO_RESERVATION
			const Status_OK
			const Status_PERMISSION_DENIED
			const Status_RESERVATION_REFUSED
			const Status_RESOURCE_LIMIT_EXCEEDED
			const Status_UNEXPECTED_MESSAGE
			const Status_UNUSED

	 type StopMessage (struct)

		Fields (total 4)
			Limit *Limit
			Peer *Peer
			Status *Status
			Type *StopMessage_Type
				This field is marked optional for backwards compatibility with proto2.
				Users should make sure to always set this.

		Methods (total 9)
			(*StopMessage) Descriptor() ([]byte, []int)
				Deprecated: Use StopMessage.ProtoReflect.Descriptor instead.

			(*StopMessage) GetLimit() *Limit
			(*StopMessage) GetPeer() *Peer
			(*StopMessage) GetStatus() Status
			(*StopMessage) GetType() StopMessage_Type
			(*StopMessage) ProtoMessage()
			(*StopMessage) ProtoReflect() protoreflect.Message
			(*StopMessage) Reset()
			(*StopMessage) String() string
		Implements (at least 5)
			*StopMessage : github.com/gogo/protobuf/proto.Message
			*StopMessage : expvar.Var
			*StopMessage : fmt.Stringer
			*StopMessage : google.golang.org/protobuf/reflect/protoreflect.ProtoMessage
			*StopMessage : google.golang.org/protobuf/runtime/protoiface.MessageV1

	 type StopMessage_Type int32 (basic type)

		Methods (total 6)
			( StopMessage_Type) Descriptor() protoreflect.EnumDescriptor
			( StopMessage_Type) Enum() *StopMessage_Type
			( StopMessage_Type) EnumDescriptor() ([]byte, []int)
				Deprecated: Use StopMessage_Type.Descriptor instead.

			( StopMessage_Type) Number() protoreflect.EnumNumber
			( StopMessage_Type) String() string
			( StopMessage_Type) Type() protoreflect.EnumType
		Implements (at least 3)
			 StopMessage_Type : expvar.Var
			 StopMessage_Type : fmt.Stringer
			 StopMessage_Type : google.golang.org/protobuf/reflect/protoreflect.Enum
		As Outputs Of (at least 2)
			func (*StopMessage).GetType() StopMessage_Type
			func StopMessage_Type.Enum() *StopMessage_Type
		As Types Of (total 2)
			const StopMessage_CONNECT
			const StopMessage_STATUS


Package-Level Variables (total 8)

	  var File_p2p_protocol_circuitv2_pb_circuit_proto protoreflect.FileDescriptor
	  var File_p2p_protocol_circuitv2_pb_voucher_proto protoreflect.FileDescriptor
	  var HopMessage_Type_name map[int32]string
		Enum value maps for HopMessage_Type.

	  var HopMessage_Type_value map[string]int32
		Enum value maps for HopMessage_Type.

	  var Status_name map[int32]string
		Enum value maps for Status.

	  var Status_value map[string]int32
		Enum value maps for Status.

	  var StopMessage_Type_name map[int32]string
		Enum value maps for StopMessage_Type.

	  var StopMessage_Type_value map[string]int32
		Enum value maps for StopMessage_Type.


Package-Level Constants (total 14)

	const HopMessage_CONNECT HopMessage_Type = 1
	const HopMessage_RESERVE HopMessage_Type = 0
	const HopMessage_STATUS HopMessage_Type = 2
	const Status_CONNECTION_FAILED Status = 203
	const Status_MALFORMED_MESSAGE Status = 400
	const Status_NO_RESERVATION Status = 204
	const Status_OK Status = 100
	const Status_PERMISSION_DENIED Status = 202
	const Status_RESERVATION_REFUSED Status = 200
	const Status_RESOURCE_LIMIT_EXCEEDED Status = 201
	const Status_UNEXPECTED_MESSAGE Status = 401
	const Status_UNUSED Status = 0
		zero value field required for proto3 compatibility

	const StopMessage_CONNECT StopMessage_Type = 0
	const StopMessage_STATUS StopMessage_Type = 1

The pages are generated with Golds v0.8.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.