-
Notifications
You must be signed in to change notification settings - Fork 256
/
Lease.xml
247 lines (247 loc) · 13 KB
/
Lease.xml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
<Type Name="Lease" FullName="Microsoft.ServiceBus.Messaging.Lease">
<TypeSignature Language="C#" Value="public class Lease" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Lease extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.ServiceBus.Messaging.Lease" />
<TypeSignature Language="VB.NET" Value="Public Class Lease" />
<TypeSignature Language="F#" Value="type Lease = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Contains partition ownership information.</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Lease ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.Lease.#ctor" />
<MemberSignature Language="VB.NET" Value="Public Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>Initializes a new instance of the <see cref="T:Microsoft.ServiceBus.Messaging.Lease" /> class.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Lease (Microsoft.ServiceBus.Messaging.Lease source);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Microsoft.ServiceBus.Messaging.Lease source) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.Lease.#ctor(Microsoft.ServiceBus.Messaging.Lease)" />
<MemberSignature Language="VB.NET" Value="Public Sub New (source As Lease)" />
<MemberSignature Language="F#" Value="new Microsoft.ServiceBus.Messaging.Lease : Microsoft.ServiceBus.Messaging.Lease -> Microsoft.ServiceBus.Messaging.Lease" Usage="new Microsoft.ServiceBus.Messaging.Lease source" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters>
<Parameter Name="source" Type="Microsoft.ServiceBus.Messaging.Lease" />
</Parameters>
<Docs>
<param name="source">The specified <see cref="M:Microsoft.ServiceBus.Messaging.Lease.#ctor(Microsoft.ServiceBus.Messaging.Lease)" /> instance where its property values will be copied from.</param>
<summary>Initializes a new instance of the
<see cref="T:Microsoft.ServiceBus.Messaging.Lease" /> class with the specified
<see cref="M:Microsoft.ServiceBus.Messaging.Lease.#ctor(Microsoft.ServiceBus.Messaging.Lease)" /> value as reference.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Epoch">
<MemberSignature Language="C#" Value="public long Epoch { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 Epoch" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.Lease.Epoch" />
<MemberSignature Language="VB.NET" Value="Public Property Epoch As Long" />
<MemberSignature Language="F#" Value="member this.Epoch : int64 with get, set" Usage="Microsoft.ServiceBus.Messaging.Lease.Epoch" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the epoch year of the lease, which is a value
you can use to determine the most recent owner of a partition between competing nodes.</summary>
<value>The epoch year of the lease.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Equals">
<MemberSignature Language="C#" Value="public override bool Equals (object obj);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool Equals(object obj) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.Lease.Equals(System.Object)" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function Equals (obj As Object) As Boolean" />
<MemberSignature Language="F#" Value="override this.Equals : obj -> bool" Usage="lease.Equals obj" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="obj" Type="System.Object" />
</Parameters>
<Docs>
<param name="obj">The object to compare.</param>
<summary>Determines whether this instance is equal to the specified object.</summary>
<returns>true if this instance is equal to the specified object; otherwise, false.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetHashCode">
<MemberSignature Language="C#" Value="public override int GetHashCode ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance int32 GetHashCode() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.Lease.GetHashCode" />
<MemberSignature Language="VB.NET" Value="Public Overrides Function GetHashCode () As Integer" />
<MemberSignature Language="F#" Value="override this.GetHashCode : unit -> int" Usage="lease.GetHashCode " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Returns the hash code of the current instance.</summary>
<returns>The hash code of the current instance.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsExpired">
<MemberSignature Language="C#" Value="public virtual bool IsExpired ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool IsExpired() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.Lease.IsExpired" />
<MemberSignature Language="VB.NET" Value="Public Overridable Function IsExpired () As Boolean" />
<MemberSignature Language="F#" Value="abstract member IsExpired : unit -> bool
override this.IsExpired : unit -> bool" Usage="lease.IsExpired " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Determines whether the lease is expired.</summary>
<returns>true if the lease is expired; otherwise, false.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Offset">
<MemberSignature Language="C#" Value="public string Offset { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Offset" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.Lease.Offset" />
<MemberSignature Language="VB.NET" Value="Public Property Offset As String" />
<MemberSignature Language="F#" Value="member this.Offset : string with get, set" Usage="Microsoft.ServiceBus.Messaging.Lease.Offset" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the current value for the offset in the stream.</summary>
<value>The lease offset.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Owner">
<MemberSignature Language="C#" Value="public string Owner { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Owner" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.Lease.Owner" />
<MemberSignature Language="VB.NET" Value="Public Property Owner As String" />
<MemberSignature Language="F#" Value="member this.Owner : string with get, set" Usage="Microsoft.ServiceBus.Messaging.Lease.Owner" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the host owner for the partition.</summary>
<value>The host owner of the partition.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="PartitionId">
<MemberSignature Language="C#" Value="public string PartitionId { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string PartitionId" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.Lease.PartitionId" />
<MemberSignature Language="VB.NET" Value="Public Property PartitionId As String" />
<MemberSignature Language="F#" Value="member this.PartitionId : string with get, set" Usage="Microsoft.ServiceBus.Messaging.Lease.PartitionId" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the ID of the partition to which this lease belongs.</summary>
<value>The partition identifier.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SequenceNumber">
<MemberSignature Language="C#" Value="public long SequenceNumber { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int64 SequenceNumber" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.Lease.SequenceNumber" />
<MemberSignature Language="VB.NET" Value="Public Property SequenceNumber As Long" />
<MemberSignature Language="F#" Value="member this.SequenceNumber : int64 with get, set" Usage="Microsoft.ServiceBus.Messaging.Lease.SequenceNumber" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int64</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the last checkpointed sequence number in the stream.</summary>
<value>Returns <see cref="T:System.Int64" />.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Token">
<MemberSignature Language="C#" Value="public string Token { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Token" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.Lease.Token" />
<MemberSignature Language="VB.NET" Value="Public Property Token As String" />
<MemberSignature Language="F#" Value="member this.Token : string with get, set" Usage="Microsoft.ServiceBus.Messaging.Lease.Token" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets or sets the lease token that manages concurrency between hosts. You can use this token to guarantee single access to any resource needed by the
<see cref="T:Microsoft.ServiceBus.Messaging.IEventProcessor" /> object.</summary>
<value>The lease token.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>