Package io.envoyproxy.envoy.extensions.dynamic_modules.v3

Interface DynamicModuleConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
DynamicModuleConfig, DynamicModuleConfig.Builder
public interface DynamicModuleConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getDoNotClose()
    Set true to prevent the module from being unloaded with dlclose.
    String
    getName()
    The name of the dynamic module.
    com.google.protobuf.ByteString
    getNameBytes()
    The name of the dynamic module.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getName

      String getName()
       The name of the dynamic module. The client is expected to have some configuration indicating where to search for the module.
 In Envoy, the search path can only be configured via the environment variable ``ENVOY_DYNAMIC_MODULES_SEARCH_PATH``.
 The actual search path is ``${ENVOY_DYNAMIC_MODULES_SEARCH_PATH}/lib${name}.so``. TODO: make the search path configurable via
 command line options.
      string name = 1 [(.validate.rules) = { ... }
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       The name of the dynamic module. The client is expected to have some configuration indicating where to search for the module.
 In Envoy, the search path can only be configured via the environment variable ``ENVOY_DYNAMIC_MODULES_SEARCH_PATH``.
 The actual search path is ``${ENVOY_DYNAMIC_MODULES_SEARCH_PATH}/lib${name}.so``. TODO: make the search path configurable via
 command line options.
      string name = 1 [(.validate.rules) = { ... }
      Returns:
      The bytes for name.

    • getDoNotClose

      boolean getDoNotClose()
       Set true to prevent the module from being unloaded with dlclose.
 This is useful for modules that have global state that should not be unloaded.
 A module is closed when no more references to it exist in the process. For example,
 no HTTP filters are using the module (e.g. after configuration update).
      bool do_not_close = 3;
      Returns:
      The doNotClose.