routev3

package
v0.0.2 Latest Latest
Warning

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

 Go to latest Published: Aug 8, 2024 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	RouteDiscoveryService_StreamRoutes_FullMethodName = "/envoy.service.route.v3.RouteDiscoveryService/StreamRoutes"
	RouteDiscoveryService_DeltaRoutes_FullMethodName  = "/envoy.service.route.v3.RouteDiscoveryService/DeltaRoutes"
	RouteDiscoveryService_FetchRoutes_FullMethodName  = "/envoy.service.route.v3.RouteDiscoveryService/FetchRoutes"
)
View Source 
const (
	ScopedRoutesDiscoveryService_StreamScopedRoutes_FullMethodName = "/envoy.service.route.v3.ScopedRoutesDiscoveryService/StreamScopedRoutes"
	ScopedRoutesDiscoveryService_DeltaScopedRoutes_FullMethodName  = "/envoy.service.route.v3.ScopedRoutesDiscoveryService/DeltaScopedRoutes"
	ScopedRoutesDiscoveryService_FetchScopedRoutes_FullMethodName  = "/envoy.service.route.v3.ScopedRoutesDiscoveryService/FetchScopedRoutes"
)
View Source 
const (
	VirtualHostDiscoveryService_DeltaVirtualHosts_FullMethodName = "/envoy.service.route.v3.VirtualHostDiscoveryService/DeltaVirtualHosts"
)

Variables

View Source 
var File_envoy_service_route_v3_rds_proto protoreflect.FileDescriptor
View Source 
var File_envoy_service_route_v3_srds_proto protoreflect.FileDescriptor
View Source 
var RouteDiscoveryService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "envoy.service.route.v3.RouteDiscoveryService",
	HandlerType: (*RouteDiscoveryServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "FetchRoutes",
			Handler:    _RouteDiscoveryService_FetchRoutes_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "StreamRoutes",
			Handler:       _RouteDiscoveryService_StreamRoutes_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
		{
			StreamName:    "DeltaRoutes",
			Handler:       _RouteDiscoveryService_DeltaRoutes_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
	},
	Metadata: "envoy/service/route/v3/rds.proto",
}

RouteDiscoveryService_ServiceDesc is the grpc.ServiceDesc for RouteDiscoveryService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var ScopedRoutesDiscoveryService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "envoy.service.route.v3.ScopedRoutesDiscoveryService",
	HandlerType: (*ScopedRoutesDiscoveryServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "FetchScopedRoutes",
			Handler:    _ScopedRoutesDiscoveryService_FetchScopedRoutes_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "StreamScopedRoutes",
			Handler:       _ScopedRoutesDiscoveryService_StreamScopedRoutes_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
		{
			StreamName:    "DeltaScopedRoutes",
			Handler:       _ScopedRoutesDiscoveryService_DeltaScopedRoutes_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
	},
	Metadata: "envoy/service/route/v3/srds.proto",
}

ScopedRoutesDiscoveryService_ServiceDesc is the grpc.ServiceDesc for ScopedRoutesDiscoveryService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var VirtualHostDiscoveryService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "envoy.service.route.v3.VirtualHostDiscoveryService",
	HandlerType: (*VirtualHostDiscoveryServiceServer)(nil),
	Methods:     []grpc.MethodDesc{},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "DeltaVirtualHosts",
			Handler:       _VirtualHostDiscoveryService_DeltaVirtualHosts_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
	},
	Metadata: "envoy/service/route/v3/rds.proto",
}

VirtualHostDiscoveryService_ServiceDesc is the grpc.ServiceDesc for VirtualHostDiscoveryService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterRouteDiscoveryServiceServer 

func RegisterRouteDiscoveryServiceServer(s grpc.ServiceRegistrar, srv RouteDiscoveryServiceServer)

func RegisterScopedRoutesDiscoveryServiceServer 

func RegisterScopedRoutesDiscoveryServiceServer(s grpc.ServiceRegistrar, srv ScopedRoutesDiscoveryServiceServer)

func RegisterVirtualHostDiscoveryServiceServer 

func RegisterVirtualHostDiscoveryServiceServer(s grpc.ServiceRegistrar, srv VirtualHostDiscoveryServiceServer)

Types

type RdsDummy 

type RdsDummy struct {
	// contains filtered or unexported fields
}

[#not-implemented-hide:] Not configuration. Workaround c++ protobuf issue with importing services: https://github.com/google/protobuf/issues/4221 and protoxform to upgrade the file.

func (*RdsDummy) Descriptor deprecated 

func (*RdsDummy) Descriptor() ([]byte, []int)

Deprecated: Use RdsDummy.ProtoReflect.Descriptor instead.

func (*RdsDummy) ProtoMessage 

func (*RdsDummy) ProtoMessage()

func (*RdsDummy) ProtoReflect 

func (x *RdsDummy) ProtoReflect() protoreflect.Message

func (*RdsDummy) Reset 

func (x *RdsDummy) Reset()

func (*RdsDummy) String 

func (x *RdsDummy) String() string

type RouteDiscoveryServiceClient 

type RouteDiscoveryServiceClient interface {
	StreamRoutes(ctx context.Context, opts ...grpc.CallOption) (grpc.BidiStreamingClient[v3.DiscoveryRequest, v3.DiscoveryResponse], error)
	DeltaRoutes(ctx context.Context, opts ...grpc.CallOption) (grpc.BidiStreamingClient[v3.DeltaDiscoveryRequest, v3.DeltaDiscoveryResponse], error)
	FetchRoutes(ctx context.Context, in *v3.DiscoveryRequest, opts ...grpc.CallOption) (*v3.DiscoveryResponse, error)
}

RouteDiscoveryServiceClient is the client API for RouteDiscoveryService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

The resource_names field in DiscoveryRequest specifies a route configuration. This allows an Envoy configuration with multiple HTTP listeners (and associated HTTP connection manager filters) to use different route configurations. Each listener will bind its HTTP connection manager filter to a route table via this identifier.

func NewRouteDiscoveryServiceClient 

func NewRouteDiscoveryServiceClient(cc grpc.ClientConnInterface) RouteDiscoveryServiceClient

type RouteDiscoveryServiceServer 

type RouteDiscoveryServiceServer interface {
	StreamRoutes(grpc.BidiStreamingServer[v3.DiscoveryRequest, v3.DiscoveryResponse]) error
	DeltaRoutes(grpc.BidiStreamingServer[v3.DeltaDiscoveryRequest, v3.DeltaDiscoveryResponse]) error
	FetchRoutes(context.Context, *v3.DiscoveryRequest) (*v3.DiscoveryResponse, error)
	// contains filtered or unexported methods
}

RouteDiscoveryServiceServer is the server API for RouteDiscoveryService service. All implementations must embed UnimplementedRouteDiscoveryServiceServer for forward compatibility.

The resource_names field in DiscoveryRequest specifies a route configuration. This allows an Envoy configuration with multiple HTTP listeners (and associated HTTP connection manager filters) to use different route configurations. Each listener will bind its HTTP connection manager filter to a route table via this identifier.

type RouteDiscoveryService_DeltaRoutesClient 

type RouteDiscoveryService_DeltaRoutesClient = grpc.BidiStreamingClient[v3.DeltaDiscoveryRequest, v3.DeltaDiscoveryResponse]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type RouteDiscoveryService_DeltaRoutesServer 

type RouteDiscoveryService_DeltaRoutesServer = grpc.BidiStreamingServer[v3.DeltaDiscoveryRequest, v3.DeltaDiscoveryResponse]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type RouteDiscoveryService_StreamRoutesClient 

type RouteDiscoveryService_StreamRoutesClient = grpc.BidiStreamingClient[v3.DiscoveryRequest, v3.DiscoveryResponse]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type RouteDiscoveryService_StreamRoutesServer 

type RouteDiscoveryService_StreamRoutesServer = grpc.BidiStreamingServer[v3.DiscoveryRequest, v3.DiscoveryResponse]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type ScopedRoutesDiscoveryServiceClient 

type ScopedRoutesDiscoveryServiceClient interface {
	StreamScopedRoutes(ctx context.Context, opts ...grpc.CallOption) (grpc.BidiStreamingClient[v3.DiscoveryRequest, v3.DiscoveryResponse], error)
	DeltaScopedRoutes(ctx context.Context, opts ...grpc.CallOption) (grpc.BidiStreamingClient[v3.DeltaDiscoveryRequest, v3.DeltaDiscoveryResponse], error)
	FetchScopedRoutes(ctx context.Context, in *v3.DiscoveryRequest, opts ...grpc.CallOption) (*v3.DiscoveryResponse, error)
}

ScopedRoutesDiscoveryServiceClient is the client API for ScopedRoutesDiscoveryService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

The Scoped Routes Discovery Service (SRDS) API distributes :ref:`ScopedRouteConfiguration<envoy_v3_api_msg.ScopedRouteConfiguration>` resources. Each ScopedRouteConfiguration resource represents a "routing scope" containing a mapping that allows the HTTP connection manager to dynamically assign a routing table (specified via a :ref:`RouteConfiguration<envoy_v3_api_msg_config.route.v3.RouteConfiguration>` message) to each HTTP request.

func NewScopedRoutesDiscoveryServiceClient 

func NewScopedRoutesDiscoveryServiceClient(cc grpc.ClientConnInterface) ScopedRoutesDiscoveryServiceClient

type ScopedRoutesDiscoveryServiceServer 

type ScopedRoutesDiscoveryServiceServer interface {
	StreamScopedRoutes(grpc.BidiStreamingServer[v3.DiscoveryRequest, v3.DiscoveryResponse]) error
	DeltaScopedRoutes(grpc.BidiStreamingServer[v3.DeltaDiscoveryRequest, v3.DeltaDiscoveryResponse]) error
	FetchScopedRoutes(context.Context, *v3.DiscoveryRequest) (*v3.DiscoveryResponse, error)
	// contains filtered or unexported methods
}

ScopedRoutesDiscoveryServiceServer is the server API for ScopedRoutesDiscoveryService service. All implementations must embed UnimplementedScopedRoutesDiscoveryServiceServer for forward compatibility.

The Scoped Routes Discovery Service (SRDS) API distributes :ref:`ScopedRouteConfiguration<envoy_v3_api_msg.ScopedRouteConfiguration>` resources. Each ScopedRouteConfiguration resource represents a "routing scope" containing a mapping that allows the HTTP connection manager to dynamically assign a routing table (specified via a :ref:`RouteConfiguration<envoy_v3_api_msg_config.route.v3.RouteConfiguration>` message) to each HTTP request.

type ScopedRoutesDiscoveryService_DeltaScopedRoutesClient 

type ScopedRoutesDiscoveryService_DeltaScopedRoutesClient = grpc.BidiStreamingClient[v3.DeltaDiscoveryRequest, v3.DeltaDiscoveryResponse]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type ScopedRoutesDiscoveryService_DeltaScopedRoutesServer 

type ScopedRoutesDiscoveryService_DeltaScopedRoutesServer = grpc.BidiStreamingServer[v3.DeltaDiscoveryRequest, v3.DeltaDiscoveryResponse]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type ScopedRoutesDiscoveryService_StreamScopedRoutesClient 

type ScopedRoutesDiscoveryService_StreamScopedRoutesClient = grpc.BidiStreamingClient[v3.DiscoveryRequest, v3.DiscoveryResponse]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type ScopedRoutesDiscoveryService_StreamScopedRoutesServer 

type ScopedRoutesDiscoveryService_StreamScopedRoutesServer = grpc.BidiStreamingServer[v3.DiscoveryRequest, v3.DiscoveryResponse]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type SrdsDummy 

type SrdsDummy struct {
	// contains filtered or unexported fields
}

[#not-implemented-hide:] Not configuration. Workaround c++ protobuf issue with importing services: https://github.com/google/protobuf/issues/4221 and protoxform to upgrade the file.

func (*SrdsDummy) Descriptor deprecated 

func (*SrdsDummy) Descriptor() ([]byte, []int)

Deprecated: Use SrdsDummy.ProtoReflect.Descriptor instead.

func (*SrdsDummy) ProtoMessage 

func (*SrdsDummy) ProtoMessage()

func (*SrdsDummy) ProtoReflect 

func (x *SrdsDummy) ProtoReflect() protoreflect.Message

func (*SrdsDummy) Reset 

func (x *SrdsDummy) Reset()

func (*SrdsDummy) String 

func (x *SrdsDummy) String() string

type UnimplementedRouteDiscoveryServiceServer 

type UnimplementedRouteDiscoveryServiceServer struct{}

UnimplementedRouteDiscoveryServiceServer must be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedRouteDiscoveryServiceServer) DeltaRoutes 

func (UnimplementedRouteDiscoveryServiceServer) DeltaRoutes(grpc.BidiStreamingServer[v3.DeltaDiscoveryRequest, v3.DeltaDiscoveryResponse]) error

func (UnimplementedRouteDiscoveryServiceServer) FetchRoutes 

func (UnimplementedRouteDiscoveryServiceServer) FetchRoutes(context.Context, *v3.DiscoveryRequest) (*v3.DiscoveryResponse, error)

func (UnimplementedRouteDiscoveryServiceServer) StreamRoutes 

func (UnimplementedRouteDiscoveryServiceServer) StreamRoutes(grpc.BidiStreamingServer[v3.DiscoveryRequest, v3.DiscoveryResponse]) error

type UnimplementedScopedRoutesDiscoveryServiceServer 

type UnimplementedScopedRoutesDiscoveryServiceServer struct{}

UnimplementedScopedRoutesDiscoveryServiceServer must be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedScopedRoutesDiscoveryServiceServer) DeltaScopedRoutes 

func (UnimplementedScopedRoutesDiscoveryServiceServer) DeltaScopedRoutes(grpc.BidiStreamingServer[v3.DeltaDiscoveryRequest, v3.DeltaDiscoveryResponse]) error

func (UnimplementedScopedRoutesDiscoveryServiceServer) FetchScopedRoutes 

func (UnimplementedScopedRoutesDiscoveryServiceServer) FetchScopedRoutes(context.Context, *v3.DiscoveryRequest) (*v3.DiscoveryResponse, error)

func (UnimplementedScopedRoutesDiscoveryServiceServer) StreamScopedRoutes 

func (UnimplementedScopedRoutesDiscoveryServiceServer) StreamScopedRoutes(grpc.BidiStreamingServer[v3.DiscoveryRequest, v3.DiscoveryResponse]) error

type UnimplementedVirtualHostDiscoveryServiceServer 

type UnimplementedVirtualHostDiscoveryServiceServer struct{}

UnimplementedVirtualHostDiscoveryServiceServer must be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedVirtualHostDiscoveryServiceServer) DeltaVirtualHosts 

func (UnimplementedVirtualHostDiscoveryServiceServer) DeltaVirtualHosts(grpc.BidiStreamingServer[v3.DeltaDiscoveryRequest, v3.DeltaDiscoveryResponse]) error

type UnsafeRouteDiscoveryServiceServer 

type UnsafeRouteDiscoveryServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeRouteDiscoveryServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to RouteDiscoveryServiceServer will result in compilation errors.

type UnsafeScopedRoutesDiscoveryServiceServer 

type UnsafeScopedRoutesDiscoveryServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeScopedRoutesDiscoveryServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ScopedRoutesDiscoveryServiceServer will result in compilation errors.

type UnsafeVirtualHostDiscoveryServiceServer 

type UnsafeVirtualHostDiscoveryServiceServer interface {
	// contains filtered or unexported methods
}

UnsafeVirtualHostDiscoveryServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to VirtualHostDiscoveryServiceServer will result in compilation errors.

type VirtualHostDiscoveryServiceClient 

type VirtualHostDiscoveryServiceClient interface {
	DeltaVirtualHosts(ctx context.Context, opts ...grpc.CallOption) (grpc.BidiStreamingClient[v3.DeltaDiscoveryRequest, v3.DeltaDiscoveryResponse], error)
}

VirtualHostDiscoveryServiceClient is the client API for VirtualHostDiscoveryService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

Virtual Host Discovery Service (VHDS) is used to dynamically update the list of virtual hosts for a given RouteConfiguration. If VHDS is configured a virtual host list update will be triggered during the processing of an HTTP request if a route for the request cannot be resolved. The :ref:`resource_names_subscribe <envoy_v3_api_field_service.discovery.v3.DeltaDiscoveryRequest.resource_names_subscribe>` field contains a list of virtual host names or aliases to track. The contents of an alias would be the contents of a “host“ or “authority“ header used to make an http request. An xDS server will match an alias to a virtual host based on the content of :ref:`domains' <envoy_v3_api_field_config.route.v3.VirtualHost.domains>` field. The “resource_names_unsubscribe“ field contains a list of virtual host names that have been :ref:`unsubscribed <xds_protocol_unsubscribe>` from the routing table associated with the RouteConfiguration.

func NewVirtualHostDiscoveryServiceClient 

func NewVirtualHostDiscoveryServiceClient(cc grpc.ClientConnInterface) VirtualHostDiscoveryServiceClient

type VirtualHostDiscoveryServiceServer 

type VirtualHostDiscoveryServiceServer interface {
	DeltaVirtualHosts(grpc.BidiStreamingServer[v3.DeltaDiscoveryRequest, v3.DeltaDiscoveryResponse]) error
	// contains filtered or unexported methods
}

VirtualHostDiscoveryServiceServer is the server API for VirtualHostDiscoveryService service. All implementations must embed UnimplementedVirtualHostDiscoveryServiceServer for forward compatibility.

Virtual Host Discovery Service (VHDS) is used to dynamically update the list of virtual hosts for a given RouteConfiguration. If VHDS is configured a virtual host list update will be triggered during the processing of an HTTP request if a route for the request cannot be resolved. The :ref:`resource_names_subscribe <envoy_v3_api_field_service.discovery.v3.DeltaDiscoveryRequest.resource_names_subscribe>` field contains a list of virtual host names or aliases to track. The contents of an alias would be the contents of a “host“ or “authority“ header used to make an http request. An xDS server will match an alias to a virtual host based on the content of :ref:`domains' <envoy_v3_api_field_config.route.v3.VirtualHost.domains>` field. The “resource_names_unsubscribe“ field contains a list of virtual host names that have been :ref:`unsubscribed <xds_protocol_unsubscribe>` from the routing table associated with the RouteConfiguration.

type VirtualHostDiscoveryService_DeltaVirtualHostsClient 

type VirtualHostDiscoveryService_DeltaVirtualHostsClient = grpc.BidiStreamingClient[v3.DeltaDiscoveryRequest, v3.DeltaDiscoveryResponse]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type VirtualHostDiscoveryService_DeltaVirtualHostsServer 

type VirtualHostDiscoveryService_DeltaVirtualHostsServer = grpc.BidiStreamingServer[v3.DeltaDiscoveryRequest, v3.DeltaDiscoveryResponse]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

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.