Class AcquireLockRequestOptions

Namespace

Azure.Iot.Operations.Services.LeasedLock

Assembly

Azure.Iot.Operations.Services.dll

Optional fields for an acquire lock request.

public class AcquireLockRequestOptions

Inheritance

object

AcquireLockRequestOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

SessionId

The optional value to include in the lock's value. If not provided, the lock's value will equal the lock holder name. If it is provided, the lock's value will equal {holderName}:{sessionId}

public string? SessionId { get; set; }

Property Value

string

Remarks

If this value is provided, then you'll need to provide the same value to SessionId or attempts to release the lock will fail.

By providing a unique sessionId, an application can use the same holderName and/or the same MQTT client in different threads to acquire the same lock without worrying about accidentally allowing two clients to both own a lock at the same time.