-
Notifications
You must be signed in to change notification settings - Fork 222
Open
Labels
acceptedThe defect or proposal as been acceptedThe defect or proposal as been acceptedgood first issueGood for newcomersGood for newcomersproposalEnhancement idea or proposalEnhancement idea or proposal
Description
Proposed change
Connect options are currently not documented, other than source code.
async def connect(
self,
servers: Union[str, List[str]] = ["nats://localhost:4222"],
error_cb: Optional[ErrorCallback] = None,
disconnected_cb: Optional[Callback] = None,
closed_cb: Optional[Callback] = None,
discovered_server_cb: Optional[Callback] = None,
reconnected_cb: Optional[Callback] = None,
name: Optional[str] = None,
pedantic: bool = False,
verbose: bool = False,
allow_reconnect: bool = True,
connect_timeout: int = DEFAULT_CONNECT_TIMEOUT,
reconnect_time_wait: int = DEFAULT_RECONNECT_TIME_WAIT,
max_reconnect_attempts: int = DEFAULT_MAX_RECONNECT_ATTEMPTS,
ping_interval: int = DEFAULT_PING_INTERVAL,
max_outstanding_pings: int = DEFAULT_MAX_OUTSTANDING_PINGS,
dont_randomize: bool = False,
flusher_queue_size: int = DEFAULT_MAX_FLUSHER_QUEUE_SIZE,
no_echo: bool = False,
tls: Optional[ssl.SSLContext] = None,
tls_hostname: Optional[str] = None,
tls_handshake_first: bool = False,
user: Optional[str] = None,
password: Optional[str] = None,
token: Optional[str] = None,
drain_timeout: int = DEFAULT_DRAIN_TIMEOUT,
signature_cb: Optional[SignatureCallback] = None,
user_jwt_cb: Optional[JWTCallback] = None,
user_credentials: Optional[Credentials] = None,
nkeys_seed: Optional[str] = None,
nkeys_seed_str: Optional[str] = None,
inbox_prefix: Union[str, bytes] = DEFAULT_INBOX_PREFIX,
pending_size: int = DEFAULT_PENDING_SIZE,
flush_timeout: Optional[float] = None,
) -> None:
It would be nice to have these as a ConnectOptions
class.
Use case
Ease of use.
Contribution
potentially!
kevinhikaruevans
Metadata
Metadata
Assignees
Labels
acceptedThe defect or proposal as been acceptedThe defect or proposal as been acceptedgood first issueGood for newcomersGood for newcomersproposalEnhancement idea or proposalEnhancement idea or proposal