Viam SDK
    Preparing search index...

    Interface DialDirectConf

    Options required to dial a robot via gRPC.

    interface DialDirectConf {
        credentials?: Credential | AccessToken;
        dialTimeout?: number;
        dialTimeoutMs?: number;
        disableSessions?: boolean;
        extraHeaders?: Record<string, string>;
        host: string;
        noReconnect?: boolean;
        reconnectAbortSignal?: { abort: boolean };
        reconnectMaxAttempts?: number;
        reconnectMaxWait?: number;
        shouldRetryOnError?: () => boolean;
    }
    Index

    Properties

    credentials? dialTimeout? dialTimeoutMs? disableSessions? extraHeaders? host noReconnect? reconnectAbortSignal? reconnectMaxAttempts? reconnectMaxWait? shouldRetryOnError?

    Properties

    credentials?: Credential | AccessToken
    dialTimeout?: number

    Set timeout in milliseconds for dialing. Default is defined by DIAL_TIMEOUT. A value of 0 disables the timeout.

    Use dialTimeoutMs instead.

    dialTimeoutMs?: number

    Set timeout in milliseconds for dialing. Default is defined by DIAL_TIMEOUT. A value of 0 disables the timeout.

    disableSessions?: boolean
    extraHeaders?: Record<string, string>
    host: string
    noReconnect?: boolean
    reconnectAbortSignal?: { abort: boolean }
    reconnectMaxAttempts?: number
    reconnectMaxWait?: number
    shouldRetryOnError?: () => boolean

    Called when a non-retryable error is encountered during reconnection. Return true to treat the error as retryable. Does not override reconnectMaxAttempts — retries are still bounded by that limit.

    Settings

    Member Visibility

    On This Page

    Properties