network: add socket interface factory and config option #11630
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,20 @@ | ||
| syntax = "proto3"; | ||
htuch marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| package envoy.config.core.v3; | ||
|
|
||
| import "udpa/annotations/status.proto"; | ||
| import "udpa/annotations/versioning.proto"; | ||
| import "validate/validate.proto"; | ||
|
|
||
| option java_package = "io.envoyproxy.envoy.config.core.v3"; | ||
| option java_outer_classname = "DefaultSocketInterfaceProto"; | ||
| option java_multiple_files = true; | ||
| option (udpa.annotations.file_status).package_version_status = ACTIVE; | ||
|
|
||
| // [#protodoc-title: Default Socket Interface configuration] | ||
| // Configuration for default socket interface that relies on OS dependent syscall to create | ||
| // sockets. | ||
| // [#extension: envoy.config.core] | ||
|
|
||
| message DefaultSocketInterface { | ||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| syntax = "proto3"; | ||
|
|
||
| package envoy.config.core.v3; | ||
|
|
||
| import "envoy/config/core/v3/extension.proto"; | ||
|
|
||
| import "udpa/annotations/status.proto"; | ||
| import "udpa/annotations/versioning.proto"; | ||
| import "validate/validate.proto"; | ||
|
|
||
| option java_package = "io.envoyproxy.envoy.config.core.v3"; | ||
| option java_outer_classname = "SocketInterfacesProto"; | ||
| option java_multiple_files = true; | ||
| option (udpa.annotations.file_status).package_version_status = ACTIVE; | ||
|
|
||
| // [#protodoc-title: Socket Interfaces Configuration ] | ||
|
|
||
| // Used to select the socket interface implementation to use | ||
| message SocketInterfacesConfig { | ||
| // Addition socket interfaces to initialize | ||
| repeated TypedExtensionConfig custom_types = 1; | ||
|
There was a problem hiding this comment. Can you document how the name or type URL of these extensions is significant and used during resolution? There was a problem hiding this comment. Done. Let me know if it's not clear. |
||
|
|
||
| // Override default socket interface | ||
| TypedExtensionConfig custom_default_type = 2; | ||
|
There was a problem hiding this comment. Should this just be a string? I.e. the extension config is above, this is just specifying some entry in it. |
||
| } | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,41 @@ | ||
| #pragma once | ||
|
|
||
| #include "envoy/config/typed_config.h" | ||
| #include "envoy/network/socket.h" | ||
| #include "envoy/registry/registry.h" | ||
|
|
||
| #include "common/singleton/threadsafe_singleton.h" | ||
|
|
||
| #include "absl/container/flat_hash_map.h" | ||
|
|
||
| namespace Envoy { | ||
| namespace Network { | ||
|
|
||
| class SocketInterfaceFactory : public virtual Config::TypedFactory { | ||
| public: | ||
| virtual SocketInterfacePtr createSocketInterface(const Protobuf::Message& config) PURE; | ||
| std::string category() const override { return "envoy.config.core.socket_interface"; } | ||
| }; | ||
|
|
||
| class DefaultSocketInterfaceFactory : public SocketInterfaceFactory { | ||
| public: | ||
| SocketInterfacePtr createSocketInterface(const Protobuf::Message& config) override; | ||
| ProtobufTypes::MessagePtr createEmptyConfigProto() override; | ||
| std::string name() const override { return "envoy.config.core.default_socket_interface"; } | ||
| }; | ||
|
|
||
| DECLARE_FACTORY(DefaultSocketInterfaceFactory); | ||
|
|
||
| using SocketInterfacesMap = absl::flat_hash_map<std::string, SocketInterfacePtr>; | ||
| using SocketInterfacesSingleton = InjectableSingleton<SocketInterfacesMap>; | ||
|
|
||
| static inline const SocketInterface* socketInterface(std::string name) { | ||
|
There was a problem hiding this comment. This is to be used to find the right There was a problem hiding this comment. Doesn't the registry basically provide this? (type_url -> factory) I'm probably missing why we need to redo this type of stuff. There was a problem hiding this comment. The way I set this up, and maybe that's not what we want, is: typed_config is handed off to If there's a nicer way this could be done with type_url, point me to an example and I'll try to follow it (still have a lot of things to learn :-() . There was a problem hiding this comment. I will defer to @lizan and @kyessenov who have more experience with the factory, but I'm wondering if we could change it slightly so the registered factory just spits out sockets and then we would just look up the factory by type_url? |
||
| auto it = SocketInterfacesSingleton::get().find(name); | ||
| if (it == SocketInterfacesSingleton::get().end()) { | ||
| return nullptr; | ||
| } | ||
| return it->second.get(); | ||
| } | ||
|
|
||
| } // namespace Network | ||
| } // namespace Envoy | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Is the thinking that these will one day be dynamically discovered by an xDS? If not, you don't need to put them in
static_resources, they can just live top-level.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Done! Actually this was just me not knowing what I was doing, so thanks for the comment!
Another thing that's confusing is the ci/circleci:docs error. Should I add the new *.proto files to some list or is there something wrong with them?