Struct SocketConfig 

pub struct SocketConfig {

    pub url: String,
    pub mode: Mode,
    pub suffix: Vec<u8>,
    pub message_handler: Option<TcpMessageHandler>,
    pub heartbeat: Option<(u64, Vec<u8>)>,
    pub reconnect_timeout_ms: Option<u64>,
    pub reconnect_delay_initial_ms: Option<u64>,
    pub reconnect_delay_max_ms: Option<u64>,
    pub reconnect_backoff_factor: Option<f64>,
    pub reconnect_jitter_ms: Option<u64>,
    pub connection_max_retries: Option<u32>,
    pub reconnect_max_attempts: Option<u32>,
    pub idle_timeout_ms: Option<u64>,
    pub certs_dir: Option<String>,
}

Configuration for TCP socket connection.

Fields

url: String

The URL to connect to.

mode: Mode

The connection mode {Plain, TLS}.

suffix: Vec<u8>

The sequence of bytes which separates lines.

message_handler: Option<TcpMessageHandler>

The optional function to handle incoming messages.

heartbeat: Option<(u64, Vec<u8>)>

The optional heartbeat with period and beat message.

reconnect_timeout_ms: Option<u64>

The timeout (milliseconds) for reconnection attempts.

reconnect_delay_initial_ms: Option<u64>

The initial reconnection delay (milliseconds) for reconnects.

reconnect_delay_max_ms: Option<u64>

The maximum reconnect delay (milliseconds) for exponential backoff.

reconnect_backoff_factor: Option<f64>

The exponential backoff factor for reconnection delays.

reconnect_jitter_ms: Option<u64>

The maximum jitter (milliseconds) added to reconnection delays.

connection_max_retries: Option<u32>

The maximum number of initial connection attempts (default: 5).

reconnect_max_attempts: Option<u32>

The maximum number of reconnection attempts before giving up.

• None: Unlimited reconnection attempts (default, recommended for production).
• Some(n): After n failed attempts, transition to CLOSED state.

idle_timeout_ms: Option<u64>

The idle timeout (milliseconds) for the read task. When set, the read task will break and trigger reconnection if no data is received within this duration. Useful for detecting silently dead connections where the server stops sending without closing.

certs_dir: Option<String>

The path to the certificates directory.

Implementations

impl SocketConfig

pub fn builder() -> SocketConfigBuilder

Create an instance of SocketConfig using the builder syntax

Trait Implementations

impl Clone for SocketConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SocketConfig

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

Formats the value using the given formatter.

impl<'a, 'py> FromPyObject<'a, 'py> for SocketConfig

where Self: Clone,

type Error = PyClassGuardError<'a, 'py>

The type returned in the event of a conversion error.

fn extract( obj: Borrowed<'a, 'py, PyAny>, ) -> Result<Self, <Self as FromPyObject<'a, 'py>>::Error>

Extracts Self from the bound smart pointer obj.

impl<'py> IntoPyObject<'py> for SocketConfig

type Target = SocketConfig

The Python output type

type Output = Bound<'py, <SocketConfig as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for SocketConfig

const NAME: &str = "SocketConfig"

Name of the class.

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for SocketConfig

const MODULE: Option<&str>

Module which the class will be associated with.

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = /// Configuration for TCP socket connection.

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type Layout = <<SocketConfig as PyClassImpl>::BaseNativeType as PyClassBaseType>::Layout<SocketConfig>

Description of how this class is laid out in memory

type BaseType = PyAny

Base class

type ThreadChecker = NoopThreadChecker

This handles following two situations:

type Inventory = Pyo3MethodsInventoryForSocketConfig

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<PyObjectOffset>

Used to provide the dictoffset slot (equivalent to tp_dictoffset)

fn weaklist_offset() -> Option<PyObjectOffset>

Used to provide the weaklistoffset slot (equivalent to tp_weaklistoffset

impl PyClassNewTextSignature for SocketConfig

const TEXT_SIGNATURE: &'static str = "(url, ssl, suffix, handler, heartbeat=None, reconnect_timeout_ms=10000, reconnect_delay_initial_ms=2000, reconnect_delay_max_ms=30000, reconnect_backoff_factor=1.5, reconnect_jitter_ms=100, connection_max_retries=5, reconnect_max_attempts=None, idle_timeout_ms=None, certs_dir=None)"

impl PyStubType for SocketConfig

fn type_output() -> TypeInfo

The type to be used in the output signature, i.e. return type of the Python function or methods.

fn type_input() -> TypeInfo

The type to be used in the input signature, i.e. the arguments of the Python function or methods.

impl PyTypeInfo for SocketConfig

const NAME: &str = <Self as ::pyo3::PyClass>::NAME

👎Deprecated since 0.28.0:

prefer using ::type_object(py).name() to get the correct runtime value

Class name.

const MODULE: Option<&str> = <Self as ::pyo3::impl_::pyclass::PyClassImpl>::MODULE

👎Deprecated since 0.28.0:

prefer using ::type_object(py).module() to get the correct runtime value

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl DerefToPyAny for SocketConfig