Skip to content
Permalink
Branch: master
Find file Copy path
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
108 lines (108 sloc) 5.99 KB
<Type Name="EventHubsPlugin" FullName="Microsoft.Azure.EventHubs.Core.EventHubsPlugin">
<TypeSignature Language="C#" Value="public abstract class EventHubsPlugin" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi abstract beforefieldinit EventHubsPlugin extends System.Object" />
<TypeSignature Language="DocId" Value="T:Microsoft.Azure.EventHubs.Core.EventHubsPlugin" />
<TypeSignature Language="VB.NET" Value="Public MustInherit Class EventHubsPlugin" />
<TypeSignature Language="F#" Value="type EventHubsPlugin = class" />
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.EventHubs</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>
This class provides methods that can be overridden to manipulate messages for custom plugin functionality.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected EventHubsPlugin ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.EventHubs.Core.EventHubsPlugin.#ctor" />
<MemberSignature Language="VB.NET" Value="Protected Sub New ()" />
<MemberType>Constructor</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.EventHubs</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="BeforeEventSend">
<MemberSignature Language="C#" Value="public virtual System.Threading.Tasks.Task&lt;Microsoft.Azure.EventHubs.EventData&gt; BeforeEventSend (Microsoft.Azure.EventHubs.EventData eventData);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance class System.Threading.Tasks.Task`1&lt;class Microsoft.Azure.EventHubs.EventData&gt; BeforeEventSend(class Microsoft.Azure.EventHubs.EventData eventData) cil managed" />
<MemberSignature Language="DocId" Value="M:Microsoft.Azure.EventHubs.Core.EventHubsPlugin.BeforeEventSend(Microsoft.Azure.EventHubs.EventData)" />
<MemberSignature Language="F#" Value="abstract member BeforeEventSend : Microsoft.Azure.EventHubs.EventData -&gt; System.Threading.Tasks.Task&lt;Microsoft.Azure.EventHubs.EventData&gt;&#xA;override this.BeforeEventSend : Microsoft.Azure.EventHubs.EventData -&gt; System.Threading.Tasks.Task&lt;Microsoft.Azure.EventHubs.EventData&gt;" Usage="eventHubsPlugin.BeforeEventSend eventData" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.EventHubs</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Threading.Tasks.Task&lt;Microsoft.Azure.EventHubs.EventData&gt;</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="eventData" Type="Microsoft.Azure.EventHubs.EventData" />
</Parameters>
<Docs>
<param name="eventData">The <see cref="T:Microsoft.Azure.EventHubs.EventData" /> to be modified by the plugin</param>
<summary>
This operation is called before an event is sent.
</summary>
<returns>The modified event <see cref="T:Microsoft.Azure.EventHubs.EventData" /></returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public abstract string Name { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Name" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.EventHubs.Core.EventHubsPlugin.Name" />
<MemberSignature Language="VB.NET" Value="Public MustOverride ReadOnly Property Name As String" />
<MemberSignature Language="F#" Value="member this.Name : string" Usage="Microsoft.Azure.EventHubs.Core.EventHubsPlugin.Name" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.EventHubs</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
Gets the name of the <see cref="T:Microsoft.Azure.EventHubs.Core.EventHubsPlugin" />.
</summary>
<value>To be added.</value>
<remarks>This name is used to identify the plugin, and prevent a plugin from being registered multiple times.</remarks>
</Docs>
</Member>
<Member MemberName="ShouldContinueOnException">
<MemberSignature Language="C#" Value="public virtual bool ShouldContinueOnException { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool ShouldContinueOnException" />
<MemberSignature Language="DocId" Value="P:Microsoft.Azure.EventHubs.Core.EventHubsPlugin.ShouldContinueOnException" />
<MemberSignature Language="VB.NET" Value="Public Overridable ReadOnly Property ShouldContinueOnException As Boolean" />
<MemberSignature Language="F#" Value="member this.ShouldContinueOnException : bool" Usage="Microsoft.Azure.EventHubs.Core.EventHubsPlugin.ShouldContinueOnException" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyName>Microsoft.Azure.EventHubs</AssemblyName>
<AssemblyVersion>4.1.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>
Determines whether or an exception in the plugin should prevent a send or receive operation.
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>
You can’t perform that action at this time.