ClientEntity ClientEntity Class

Definition

A data structure that represents the events sent and received from an Event Hub stream.

public abstract class ClientEntity : IMessageClientEntity, ICloseablePublic MustInherit Class ClientEntity
    Implements IMessageClientEntity, ICloseable
Inheritance
ClientEntityClientEntity
Derived

Inherited Members

System.Object

Properties

IsClosed IsClosed

public bool IsClosed { get; }Public ReadOnly Property IsClosed As Boolean
Value
Boolean Boolean

Returns Boolean.

RetryPolicy RetryPolicy

public RetryPolicy RetryPolicy { get; set; }Public Property RetryPolicy As RetryPolicy

ThisLock ThisLock

protected object ThisLock { get; }Protected ReadOnly Property ThisLock As Object
Value
Object Object

Returns Object.

Methods

Abort() Abort()

Performs abort functionality on the messaging entity.

public virtual void Abort()Public Overridable Sub Abort

Close() Close()

Sends a cleanup message to Service Bus to signal the completion of the usage of an entity.

public void Close()Public Sub Close

Remarks

In the event of any exceptions, the method will perform an abort on the entity before throwing the exception.

CloseAsync() CloseAsync()

Sends a cleanup message asynchronously to Service Bus to signal the completion of the usage of an entity.

public Task CloseAsync()Public Function CloseAsync As Task
Returns

If an exception occurs, this method performs an abort operation on the entity before throwing the exception.

Remarks

In the event of any exceptions, the method will perform an abort on the entity before throwing the exception.

Fault() Fault()

For internal use only. Do not inherit from this class.

protected void Fault()Protected Sub Fault

Finalize() Finalize()

protected void Finalize()Protected Sub Finalize

OnAbort() OnAbort()

protected abstract void OnAbort()Protected MustOverride Sub OnAbort

OnBeginClose(TimeSpan, AsyncCallback, Object) OnBeginClose(TimeSpan, AsyncCallback, Object)

protected abstract IAsyncResult OnBeginClose(TimeSpan timeout, AsyncCallback callback, object state)Protected MustOverride Function OnBeginClose(timeout As TimeSpan, callback As AsyncCallback, state As Object) As IAsyncResult
Parameters
timeout
TimeSpan TimeSpan
state
Object Object
Returns

OnBeginOpen(TimeSpan, AsyncCallback, Object) OnBeginOpen(TimeSpan, AsyncCallback, Object)

protected abstract IAsyncResult OnBeginOpen(TimeSpan timeout, AsyncCallback callback, object state)Protected MustOverride Function OnBeginOpen(timeout As TimeSpan, callback As AsyncCallback, state As Object) As IAsyncResult
Parameters
timeout
TimeSpan TimeSpan
state
Object Object
Returns

OnClose(TimeSpan) OnClose(TimeSpan)

protected virtual void OnClose(TimeSpan timeout)Protected Overridable Sub OnClose(timeout As TimeSpan)
Parameters
timeout
TimeSpan TimeSpan

OnClosed() OnClosed()

protected virtual void OnClosed()Protected Overridable Sub OnClosed

OnEndClose(IAsyncResult) OnEndClose(IAsyncResult)

protected abstract void OnEndClose(IAsyncResult result)Protected MustOverride Sub OnEndClose(result As IAsyncResult)
Parameters

OnEndOpen(IAsyncResult) OnEndOpen(IAsyncResult)

protected abstract void OnEndOpen(IAsyncResult result)Protected MustOverride Sub OnEndOpen(result As IAsyncResult)
Parameters

OnFaulted() OnFaulted()

protected virtual void OnFaulted()Protected Overridable Sub OnFaulted

OnOpen(TimeSpan) OnOpen(TimeSpan)

protected virtual void OnOpen(TimeSpan timeout)Protected Overridable Sub OnOpen(timeout As TimeSpan)
Parameters
timeout
TimeSpan TimeSpan

OnOpened() OnOpened()

protected virtual void OnOpened()Protected Overridable Sub OnOpened

ThrowIfClosed() ThrowIfClosed()

protected void ThrowIfClosed()Protected Sub ThrowIfClosed

ThrowIfDisposed() ThrowIfDisposed()

protected void ThrowIfDisposed()Protected Sub ThrowIfDisposed

ThrowIfDisposedOrImmutable() ThrowIfDisposedOrImmutable()

protected void ThrowIfDisposedOrImmutable()Protected Sub ThrowIfDisposedOrImmutable

ThrowIfDisposedOrNotOpen() ThrowIfDisposedOrNotOpen()

protected void ThrowIfDisposedOrNotOpen()Protected Sub ThrowIfDisposedOrNotOpen

ThrowIfFaulted() ThrowIfFaulted()

protected void ThrowIfFaulted()Protected Sub ThrowIfFaulted