Skip to content

sift_py.grpc.keepalive

CLASS DESCRIPTION
KeepaliveConfig

Make make this public in the future to allow folks to configure their own keepalive settings

ATTRIBUTE DESCRIPTION
DEFAULT_KEEPALIVE_CONFIG

TYPE: KeepaliveConfig

DEFAULT_KEEPALIVE_PERMIT_WITHOUT_CALLS

Allows connection without any active RPCs

DEFAULT_KEEPALIVE_TIMEOUT_MS

Timeout while waiting for server to acknowledge keepalive ping

DEFAULT_KEEPALIVE_TIME_MS

Interval with which to send keepalive pings

DEFAULT_MAX_PINGS_WITHOUT_DATA

Disabled

DEFAULT_KEEPALIVE_CONFIG module-attribute

DEFAULT_KEEPALIVE_CONFIG: KeepaliveConfig = {
    "keepalive_time_ms": DEFAULT_KEEPALIVE_TIME_MS,
    "keepalive_timeout_ms": DEFAULT_KEEPALIVE_TIMEOUT_MS,
    "keepalive_permit_without_calls": DEFAULT_KEEPALIVE_PERMIT_WITHOUT_CALLS,
    "max_pings_without_data": DEFAULT_MAX_PINGS_WITHOUT_DATA,
}

DEFAULT_KEEPALIVE_PERMIT_WITHOUT_CALLS module-attribute

DEFAULT_KEEPALIVE_PERMIT_WITHOUT_CALLS = 1

Allows connection without any active RPCs

DEFAULT_KEEPALIVE_TIMEOUT_MS module-attribute

DEFAULT_KEEPALIVE_TIMEOUT_MS = 20000

Timeout while waiting for server to acknowledge keepalive ping

DEFAULT_KEEPALIVE_TIME_MS module-attribute

DEFAULT_KEEPALIVE_TIME_MS = 20000

Interval with which to send keepalive pings

DEFAULT_MAX_PINGS_WITHOUT_DATA module-attribute

DEFAULT_MAX_PINGS_WITHOUT_DATA = 0

Disabled

KeepaliveConfig

Bases: TypedDict

Make make this public in the future to allow folks to configure their own keepalive settings if there is demand for it.

ATTRIBUTE DESCRIPTION
keepalive_permit_without_calls

TYPE: int

keepalive_time_ms

TYPE: int

keepalive_timeout_ms

TYPE: int

max_pings_without_data

TYPE: int

keepalive_permit_without_calls instance-attribute

keepalive_permit_without_calls: int

keepalive_time_ms instance-attribute

keepalive_time_ms: int

keepalive_timeout_ms instance-attribute

keepalive_timeout_ms: int

max_pings_without_data instance-attribute

max_pings_without_data: int