Struct WebSocketConfig

pub struct WebSocketConfig {
    pub common: WebSocketCommonConfig,
    pub decoding: DeserializerConfig,
    pub framing: FramingConfig,
    pub connect_timeout_secs: Duration,
    pub initial_message_timeout_secs: Duration,
    pub initial_message: Option<String>,
    pub ping_message: Option<String>,
    pub pong_message: Option<PongMessage>,
    pub log_namespace: Option<bool>,
}

Configuration for the websocket source.

Fields

common: WebSocketCommonConfig

decoding: DeserializerConfig

Decoder to use on each received message.

framing: FramingConfig

Framing to use in the decoding.

connect_timeout_secs: Duration

Number of seconds before timing out while connecting.

initial_message_timeout_secs: Duration

Number of seconds before timing out while waiting for a reply to the initial message. This is only used when initial_message is also configured.

initial_message: Option<String>

An optional message to send to the server upon connection.

ping_message: Option<String>

An optional application-level ping message to send over the WebSocket connection. If not set, a standard WebSocket ping control frame is sent instead.

pong_message: Option<PongMessage>

The expected application-level pong message to listen for as a response to a custom ping_message. This is only used when ping_message is also configured. When a custom ping is sent, receiving this specific message confirms that the connection is still alive.

log_namespace: Option<bool>

The namespace to use for logs. This overrides the global setting.

Trait Implementations

impl Clone for WebSocketConfig

fn clone(&self) -> WebSocketConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Configurable for WebSocketConfig

fn referenceable_name() -> Option<&'static str>

Gets the referenceable name of this value, if any.

fn metadata() -> Metadata

Gets the metadata for this value.

fn generate_schema( schema_gen: &RefCell<SchemaGenerator>, ) -> Result<SchemaObject, GenerateError>

Generates the schema for this value.

fn is_optional() -> bool

where Self: Sized,

Whether or not this value is optional.

fn validate_metadata(_metadata: &Metadata) -> Result<(), GenerateError>

where Self: Sized,

Validates the given metadata against this type.

fn as_configurable_ref() -> ConfigurableRef

where Self: Sized + 'static,

Create a new configurable reference table.

impl Debug for WebSocketConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for WebSocketConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WebSocketConfig

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl GenerateConfig for WebSocketConfig

fn generate_config() -> Value

impl NamedComponent for WebSocketConfig

fn get_component_name(&self) -> &'static str

Gets the name of the component.

impl Serialize for WebSocketConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl SourceConfig for WebSocketConfig

fn build<'life0, 'async_trait>( &'life0 self, cx: SourceContext, ) -> Pin<Box<dyn Future<Output = Result<Source>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Builds the source with the given context.

fn outputs(&self, global_log_namespace: LogNamespace) -> Vec<SourceOutput>

Gets the list of outputs exposed by this source.

fn can_acknowledge(&self) -> bool

Whether or not this source can acknowledge the events it emits.

fn resources(&self) -> Vec<Resource>

Gets the list of resources, if any, used by this source.

impl ToValue for WebSocketConfig

fn to_value(&self) -> Value

Convert this value into a serde_json::Value. Must not fail.