-
Notifications
You must be signed in to change notification settings - Fork 260
/
Filter.xml
170 lines (170 loc) · 10.9 KB
/
Filter.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
<Type Name="Filter" FullName="Microsoft.ServiceBus.Messaging.Filter">
<TypeSignature Language="C#" Value="public abstract class Filter : System.Runtime.Serialization.IExtensibleDataObject" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit Filter extends System.Object implements class System.Runtime.Serialization.IExtensibleDataObject" />
<TypeSignature Language="DocId" Value="T:Microsoft.ServiceBus.Messaging.Filter" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class Filter
Implements IExtensibleDataObject" />
<TypeSignature Language="F#" Value="type Filter = class
 interface IExtensibleDataObject" />
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.Runtime.Serialization.IExtensibleDataObject</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Serialization.DataContract(Name="Filter", Namespace="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect")]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Serialization.DataContract(Name="Filter", Namespace="http://schemas.microsoft.com/netservices/2010/10/servicebus/connect")>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Serialization.KnownType(typeof(Microsoft.ServiceBus.Messaging.SqlFilter))]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Serialization.KnownType(typeof(Microsoft.ServiceBus.Messaging.SqlFilter))>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Serialization.KnownType(typeof(Microsoft.ServiceBus.Messaging.TrueFilter))]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Serialization.KnownType(typeof(Microsoft.ServiceBus.Messaging.TrueFilter))>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Serialization.KnownType(typeof(Microsoft.ServiceBus.Messaging.FalseFilter))]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Serialization.KnownType(typeof(Microsoft.ServiceBus.Messaging.FalseFilter))>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Serialization.KnownType(typeof(Microsoft.ServiceBus.Messaging.CorrelationFilter))]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Serialization.KnownType(typeof(Microsoft.ServiceBus.Messaging.CorrelationFilter))>]</AttributeName>
</Attribute>
<Attribute>
<AttributeName Language="C#">[System.Runtime.Serialization.KnownType(typeof(System.DateTimeOffset))]</AttributeName>
<AttributeName Language="F#">[<System.Runtime.Serialization.KnownType(typeof(System.DateTimeOffset))>]</AttributeName>
</Attribute>
</Attributes>
<Docs>
<summary>Describes a filter expression that is evaluated against a BrokeredMessage.</summary>
<remarks>
Filter is an abstract class with the following concrete implementations:
<list type="bullet"><item><b>SqlFilter</b> that represents a filter using SQL syntax. </item><item><b>CorrelationFilter</b> that provides an optimization for correlation equality expressions.</item></list></remarks>
<altmember cref="T:Microsoft.ServiceBus.Messaging.SqlFilter" />
<altmember cref="T:Microsoft.ServiceBus.Messaging.TrueFilter" />
<altmember cref="T:Microsoft.ServiceBus.Messaging.CorrelationFilter" />
<altmember cref="T:Microsoft.ServiceBus.Messaging.FalseFilter" />
</Docs>
<Members>
<Member MemberName="Match">
<MemberSignature Language="C#" Value="public abstract bool Match (Microsoft.ServiceBus.Messaging.BrokeredMessage message);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool Match(class Microsoft.ServiceBus.Messaging.BrokeredMessage message) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.Filter.Match(Microsoft.ServiceBus.Messaging.BrokeredMessage)" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function Match (message As BrokeredMessage) As Boolean" />
<MemberSignature Language="F#" Value="abstract member Match : Microsoft.ServiceBus.Messaging.BrokeredMessage -> bool" Usage="filter.Match message" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="message" Type="Microsoft.ServiceBus.Messaging.BrokeredMessage" />
</Parameters>
<Docs>
<param name="message">The BrokeredMessage object.</param>
<summary>Matches the BrokeredMessage against the FilterExpression.</summary>
<returns>true if the BrokeredMessage matches the filtering expression; otherwise, false.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">The operation is invalid with the current state of object.</exception>
<exception cref="T:Microsoft.ServiceBus.Messaging.FilterException">Filter evaluation failed.</exception>
</Docs>
</Member>
<Member MemberName="Preprocess">
<MemberSignature Language="C#" Value="public abstract Microsoft.ServiceBus.Messaging.Filter Preprocess ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class Microsoft.ServiceBus.Messaging.Filter Preprocess() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.Filter.Preprocess" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Function Preprocess () As Filter" />
<MemberSignature Language="F#" Value="abstract member Preprocess : unit -> Microsoft.ServiceBus.Messaging.Filter" Usage="filter.Preprocess " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>Microsoft.ServiceBus.Messaging.Filter</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Preprocesses the filter expression and returns a preprocessed FilterExpression.</summary>
<returns>The preprocessed FilterExpression.</returns>
<remarks>To be added.</remarks>
<exception cref="T:System.InvalidOperationException">The operation is invalid with the current state of object.</exception>
</Docs>
</Member>
<Member MemberName="RequiresPreprocessing">
<MemberSignature Language="C#" Value="public abstract bool RequiresPreprocessing { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool RequiresPreprocessing" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.Filter.RequiresPreprocessing" />
<MemberSignature Language="VB.NET" Value="Public MustOverride ReadOnly Property RequiresPreprocessing As Boolean" />
<MemberSignature Language="F#" Value="member this.RequiresPreprocessing : bool" Usage="Microsoft.ServiceBus.Messaging.Filter.RequiresPreprocessing" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets a value indicating whether the filter expression requires preprocessing.</summary>
<value>true if the filter expression requires preprocessing; otherwise, false.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="System.Runtime.Serialization.IExtensibleDataObject.ExtensionData">
<MemberSignature Language="C#" Value="System.Runtime.Serialization.ExtensionDataObject System.Runtime.Serialization.IExtensibleDataObject.ExtensionData { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class System.Runtime.Serialization.ExtensionDataObject System.Runtime.Serialization.IExtensibleDataObject.ExtensionData" />
<MemberSignature Language="DocId" Value="P:Microsoft.ServiceBus.Messaging.Filter.System#Runtime#Serialization#IExtensibleDataObject#ExtensionData" />
<MemberSignature Language="VB.NET" Value=" Property ExtensionData As ExtensionDataObject Implements IExtensibleDataObject.ExtensionData" />
<MemberSignature Language="F#" Value="member this.System.Runtime.Serialization.IExtensibleDataObject.ExtensionData : System.Runtime.Serialization.ExtensionDataObject with get, set" Usage="System.Runtime.Serialization.IExtensibleDataObject.ExtensionData" />
<MemberType>Property</MemberType>
<Implements>
<InterfaceMember>P:System.Runtime.Serialization.IExtensibleDataObject.ExtensionData</InterfaceMember>
</Implements>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Runtime.Serialization.ExtensionDataObject</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Validate">
<MemberSignature Language="C#" Value="public abstract void Validate ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Validate() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.ServiceBus.Messaging.Filter.Validate" />
<MemberSignature Language="VB.NET" Value="Public MustOverride Sub Validate ()" />
<MemberSignature Language="F#" Value="abstract member Validate : unit -> unit" Usage="filter.Validate " />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.ServiceBus</AssemblyName>
<AssemblyVersion>3.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Validates the FilterExpression and make sure it complies with the valid grammar rules.</summary>
<remarks>To be added.</remarks>
<exception cref="T:Microsoft.ServiceBus.Messaging.FilterException">The filter statement is invalid or is potentially complex
enough to consume too much computing power when evaluating the statement.</exception>
</Docs>
</Member>
</Members>
</Type>