.NET Client Documentation
5.3.0
Search Results for

    Show / Hide Table of Contents

    StartNewClientAsync Method

    StartNewClientAsync(CancellationToken)

    Starts a new IHazelcastClient instance with automatic options.

    Declaration
    [Obsolete("The method is obsolete. Use other overloads.", true)]
    public static ValueTask<IHazelcastClient> StartNewClientAsync(CancellationToken cancellationToken = default)
    Parameters
    CancellationToken cancellationToken

    An optional cancellation token.

    Returns
    ValueTask<IHazelcastClient>

    A new IHazelcastClient instance.

    Remarks

    Options are built via the method.

    By default, the client connection timeout is infinite. If this method cannot establish a connection to a cluster at the configured addresses, it may appear to hang as it retries forever. You may want to configure a timeout via the options.Networking.ConnectionRetry.ClusterConnectionTimeoutMilliseconds configuration option.

    StartNewClientAsync(Action<HazelcastOptions>, CancellationToken)

    Starts a new IHazelcastClient instance with configured options.

    Declaration
    public static ValueTask<IHazelcastClient> StartNewClientAsync(Action<HazelcastOptions> configure, CancellationToken cancellationToken = default)
    Parameters
    Action<HazelcastOptions> configure

    A HazelcastOptions configuration delegate.

    CancellationToken cancellationToken

    A optional cancellation token.

    Returns
    ValueTask<IHazelcastClient>

    A new IHazelcastClient instance.

    Remarks

    Options are built via the method and passed to the configure method, where they can be refined and adjusted, before being used to create the client.

    By default, the client connection timeout is infinite. If this method cannot establish a connection to a cluster at the configured addresses, it may appear to hang as it retries forever. You may want to configure a timeout via the options.Networking.ConnectionRetry.ClusterConnectionTimeoutMilliseconds configuration option.

    StartNewClientAsync(HazelcastOptions, CancellationToken)

    Starts a new IHazelcastClient instance with options.

    Declaration
    public static ValueTask<IHazelcastClient> StartNewClientAsync(HazelcastOptions options, CancellationToken cancellationToken = default)
    Parameters
    HazelcastOptions options

    Options.

    CancellationToken cancellationToken

    A optional cancellation token.

    Returns
    ValueTask<IHazelcastClient>

    A new IHazelcastClient instance.

    Remarks

    By default, the client connection timeout is infinite. If this method cannot establish a connection to a cluster at the configured addresses, it may appear to hang as it retries forever. You may want to configure a timeout via the options.Networking.ConnectionRetry.ClusterConnectionTimeoutMilliseconds configuration option.

    In This Article
    Back to top Copyright © 2010-2023 Hazelcast, Inc. All rights reserved.
    Generated by DocFX.