routev3grpc

package
v1.4.0-20240430201506-... Latest Latest
Warning

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

 Go to latest Published: unknown License: Apache-2.0 Imports: 5 Imported by: 1

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 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 RouteDiscoveryServiceClient 

type RouteDiscoveryServiceClient interface {
	StreamRoutes(ctx context.Context, opts ...grpc.CallOption) (RouteDiscoveryService_StreamRoutesClient, error)
	DeltaRoutes(ctx context.Context, opts ...grpc.CallOption) (RouteDiscoveryService_DeltaRoutesClient, 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(RouteDiscoveryService_StreamRoutesServer) error
	DeltaRoutes(RouteDiscoveryService_DeltaRoutesServer) error
	FetchRoutes(context.Context, *v3.DiscoveryRequest) (*v3.DiscoveryResponse, error)
}

RouteDiscoveryServiceServer is the server API for RouteDiscoveryService service. All implementations should 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 interface {
	Send(*v3.DeltaDiscoveryRequest) error
	Recv() (*v3.DeltaDiscoveryResponse, error)
	grpc.ClientStream
}

type RouteDiscoveryService_DeltaRoutesServer 

type RouteDiscoveryService_DeltaRoutesServer interface {
	Send(*v3.DeltaDiscoveryResponse) error
	Recv() (*v3.DeltaDiscoveryRequest, error)
	grpc.ServerStream
}

type RouteDiscoveryService_StreamRoutesClient 

type RouteDiscoveryService_StreamRoutesClient interface {
	Send(*v3.DiscoveryRequest) error
	Recv() (*v3.DiscoveryResponse, error)
	grpc.ClientStream
}

type RouteDiscoveryService_StreamRoutesServer 

type RouteDiscoveryService_StreamRoutesServer interface {
	Send(*v3.DiscoveryResponse) error
	Recv() (*v3.DiscoveryRequest, error)
	grpc.ServerStream
}

type ScopedRoutesDiscoveryServiceClient 

type ScopedRoutesDiscoveryServiceClient interface {
	StreamScopedRoutes(ctx context.Context, opts ...grpc.CallOption) (ScopedRoutesDiscoveryService_StreamScopedRoutesClient, error)
	DeltaScopedRoutes(ctx context.Context, opts ...grpc.CallOption) (ScopedRoutesDiscoveryService_DeltaScopedRoutesClient, 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(ScopedRoutesDiscoveryService_StreamScopedRoutesServer) error
	DeltaScopedRoutes(ScopedRoutesDiscoveryService_DeltaScopedRoutesServer) error
	FetchScopedRoutes(context.Context, *v3.DiscoveryRequest) (*v3.DiscoveryResponse, error)
}

ScopedRoutesDiscoveryServiceServer is the server API for ScopedRoutesDiscoveryService service. All implementations should 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 interface {
	Send(*v3.DeltaDiscoveryRequest) error
	Recv() (*v3.DeltaDiscoveryResponse, error)
	grpc.ClientStream
}

type ScopedRoutesDiscoveryService_DeltaScopedRoutesServer 

type ScopedRoutesDiscoveryService_DeltaScopedRoutesServer interface {
	Send(*v3.DeltaDiscoveryResponse) error
	Recv() (*v3.DeltaDiscoveryRequest, error)
	grpc.ServerStream
}

type ScopedRoutesDiscoveryService_StreamScopedRoutesClient 

type ScopedRoutesDiscoveryService_StreamScopedRoutesClient interface {
	Send(*v3.DiscoveryRequest) error
	Recv() (*v3.DiscoveryResponse, error)
	grpc.ClientStream
}

type ScopedRoutesDiscoveryService_StreamScopedRoutesServer 

type ScopedRoutesDiscoveryService_StreamScopedRoutesServer interface {
	Send(*v3.DiscoveryResponse) error
	Recv() (*v3.DiscoveryRequest, error)
	grpc.ServerStream
}

type UnimplementedRouteDiscoveryServiceServer 

type UnimplementedRouteDiscoveryServiceServer struct {
}

UnimplementedRouteDiscoveryServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedRouteDiscoveryServiceServer) DeltaRoutes 

func (UnimplementedRouteDiscoveryServiceServer) DeltaRoutes(RouteDiscoveryService_DeltaRoutesServer) error

func (UnimplementedRouteDiscoveryServiceServer) FetchRoutes 

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

func (UnimplementedRouteDiscoveryServiceServer) StreamRoutes 

func (UnimplementedRouteDiscoveryServiceServer) StreamRoutes(RouteDiscoveryService_StreamRoutesServer) error

type UnimplementedScopedRoutesDiscoveryServiceServer 

type UnimplementedScopedRoutesDiscoveryServiceServer struct {
}

UnimplementedScopedRoutesDiscoveryServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedScopedRoutesDiscoveryServiceServer) DeltaScopedRoutes 

func (UnimplementedScopedRoutesDiscoveryServiceServer) DeltaScopedRoutes(ScopedRoutesDiscoveryService_DeltaScopedRoutesServer) error

func (UnimplementedScopedRoutesDiscoveryServiceServer) FetchScopedRoutes 

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

func (UnimplementedScopedRoutesDiscoveryServiceServer) StreamScopedRoutes 

func (UnimplementedScopedRoutesDiscoveryServiceServer) StreamScopedRoutes(ScopedRoutesDiscoveryService_StreamScopedRoutesServer) error

type UnimplementedVirtualHostDiscoveryServiceServer 

type UnimplementedVirtualHostDiscoveryServiceServer struct {
}

UnimplementedVirtualHostDiscoveryServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedVirtualHostDiscoveryServiceServer) DeltaVirtualHosts 

func (UnimplementedVirtualHostDiscoveryServiceServer) DeltaVirtualHosts(VirtualHostDiscoveryService_DeltaVirtualHostsServer) 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) (VirtualHostDiscoveryService_DeltaVirtualHostsClient, 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(VirtualHostDiscoveryService_DeltaVirtualHostsServer) error
}

VirtualHostDiscoveryServiceServer is the server API for VirtualHostDiscoveryService service. All implementations should 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 interface {
	Send(*v3.DeltaDiscoveryRequest) error
	Recv() (*v3.DeltaDiscoveryResponse, error)
	grpc.ClientStream
}

type VirtualHostDiscoveryService_DeltaVirtualHostsServer 

type VirtualHostDiscoveryService_DeltaVirtualHostsServer interface {
	Send(*v3.DeltaDiscoveryResponse) error
	Recv() (*v3.DeltaDiscoveryRequest, error)
	grpc.ServerStream
}

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.