Skip to main content

Interface ISessionEndpoint

Namespace: Consul
Assembly: Consul.dll

The interface for the Session API Endpoints

public interface ISessionEndpoint

Methods

Create(CancellationToken)

Task<WriteResult<string>> Create(CancellationToken ct = default)

Parameters

ct CancellationToken

Returns

Task <WriteResult <string >>

Create(SessionEntry, CancellationToken)

Task<WriteResult<string>> Create(SessionEntry se, CancellationToken ct = default)

Parameters

se SessionEntry

ct CancellationToken

Returns

Task <WriteResult <string >>

Create(SessionEntry, WriteOptions, CancellationToken)

Task<WriteResult<string>> Create(SessionEntry se, WriteOptions q, CancellationToken ct = default)

Parameters

se SessionEntry

q WriteOptions

ct CancellationToken

Returns

Task <WriteResult <string >>

CreateNoChecks(CancellationToken)

Task<WriteResult<string>> CreateNoChecks(CancellationToken ct = default)

Parameters

ct CancellationToken

Returns

Task <WriteResult <string >>

CreateNoChecks(SessionEntry, CancellationToken)

Task<WriteResult<string>> CreateNoChecks(SessionEntry se, CancellationToken ct = default)

Parameters

se SessionEntry

ct CancellationToken

Returns

Task <WriteResult <string >>

CreateNoChecks(SessionEntry, WriteOptions, CancellationToken)

Task<WriteResult<string>> CreateNoChecks(SessionEntry se, WriteOptions q, CancellationToken ct = default)

Parameters

se SessionEntry

q WriteOptions

ct CancellationToken

Returns

Task <WriteResult <string >>

Destroy(string, CancellationToken)

Task<WriteResult<bool>> Destroy(string id, CancellationToken ct = default)

Parameters

id string

ct CancellationToken

Returns

Task <WriteResult <bool >>

Destroy(string, WriteOptions, CancellationToken)

Task<WriteResult<bool>> Destroy(string id, WriteOptions q, CancellationToken ct = default)

Parameters

id string

q WriteOptions

ct CancellationToken

Returns

Task <WriteResult <bool >>

Info(string, CancellationToken)

Task<QueryResult<SessionEntry>> Info(string id, CancellationToken ct = default)

Parameters

id string

ct CancellationToken

Returns

Task <QueryResult <SessionEntry >>

Info(string, QueryOptions, CancellationToken)

Task<QueryResult<SessionEntry>> Info(string id, QueryOptions q, CancellationToken ct = default)

Parameters

id string

q QueryOptions

ct CancellationToken

Returns

Task <QueryResult <SessionEntry >>

List(CancellationToken)

Task<QueryResult<SessionEntry[]>> List(CancellationToken ct = default)

Parameters

ct CancellationToken

Returns

Task <QueryResult <SessionEntry []>>

List(QueryOptions, CancellationToken)

Task<QueryResult<SessionEntry[]>> List(QueryOptions q, CancellationToken ct = default)

Parameters

q QueryOptions

ct CancellationToken

Returns

Task <QueryResult <SessionEntry []>>

Node(string, CancellationToken)

Task<QueryResult<SessionEntry[]>> Node(string node, CancellationToken ct = default)

Parameters

node string

ct CancellationToken

Returns

Task <QueryResult <SessionEntry []>>

Node(string, QueryOptions, CancellationToken)

Task<QueryResult<SessionEntry[]>> Node(string node, QueryOptions q, CancellationToken ct = default)

Parameters

node string

q QueryOptions

ct CancellationToken

Returns

Task <QueryResult <SessionEntry []>>

Renew(string, CancellationToken)

Task<WriteResult<SessionEntry>> Renew(string id, CancellationToken ct = default)

Parameters

id string

ct CancellationToken

Returns

Task <WriteResult <SessionEntry >>

Renew(string, WriteOptions, CancellationToken)

Task<WriteResult<SessionEntry>> Renew(string id, WriteOptions q, CancellationToken ct = default)

Parameters

id string

q WriteOptions

ct CancellationToken

Returns

Task <WriteResult <SessionEntry >>

RenewPeriodic(TimeSpan, string, CancellationToken)

Task RenewPeriodic(TimeSpan initialTTL, string id, CancellationToken ct)

Parameters

initialTTL TimeSpan

id string

ct CancellationToken

Returns

Task

RenewPeriodic(TimeSpan, string, WriteOptions, CancellationToken)

Task RenewPeriodic(TimeSpan initialTTL, string id, WriteOptions q, CancellationToken ct)

Parameters

initialTTL TimeSpan

id string

q WriteOptions

ct CancellationToken

Returns

Task

  • Methods
    • Create(CancellationToken)
    • Create(SessionEntry, CancellationToken)
    • Create(SessionEntry, WriteOptions, CancellationToken)
    • CreateNoChecks(CancellationToken)
    • CreateNoChecks(SessionEntry, CancellationToken)
    • CreateNoChecks(SessionEntry, WriteOptions, CancellationToken)
    • Destroy(string, CancellationToken)
    • Destroy(string, WriteOptions, CancellationToken)
    • Info(string, CancellationToken)
    • Info(string, QueryOptions, CancellationToken)
    • List(CancellationToken)
    • List(QueryOptions, CancellationToken)
    • Node(string, CancellationToken)
    • Node(string, QueryOptions, CancellationToken)
    • Renew(string, CancellationToken)
    • Renew(string, WriteOptions, CancellationToken)
    • RenewPeriodic(TimeSpan, string, CancellationToken)
    • RenewPeriodic(TimeSpan, string, WriteOptions, CancellationToken)