Table of Contents

Class ClientEntity

Namespace
Microsoft.ServiceBus.Messaging
Assembly
Microsoft.ServiceBus.dll

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

public abstract class ClientEntity
Inheritance
ClientEntity
Derived
Inherited Members

Properties

IsClosed 

public bool IsClosed { get; }

Property Value

bool

Returns bool.

RetryPolicy 

public RetryPolicy RetryPolicy { get; set; }

Property Value

RetryPolicy

Returns RetryPolicy.

ThisLock 

protected object ThisLock { get; }

Property Value

object

Returns object.

Methods

Abort()

Performs abort functionality on the messaging entity.

public virtual void Abort()

Close()

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

public void Close()

CloseAsync()

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

public Task CloseAsync()

Returns

Task

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

Fault()

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

protected void Fault()

OnAbort() 

protected abstract void OnAbort()

OnBeginClose(TimeSpan, AsyncCallback, object) 

protected abstract IAsyncResult OnBeginClose(TimeSpan timeout, AsyncCallback callback, object state)

Parameters

timeout TimeSpan
callback AsyncCallback
state object

Returns

IAsyncResult

Returns IAsyncResult.

OnBeginOpen(TimeSpan, AsyncCallback, object) 

protected abstract IAsyncResult OnBeginOpen(TimeSpan timeout, AsyncCallback callback, object state)

Parameters

timeout TimeSpan
callback AsyncCallback
state object

Returns

IAsyncResult

Returns IAsyncResult.

OnClose(TimeSpan) 

protected virtual void OnClose(TimeSpan timeout)

Parameters

timeout TimeSpan

OnClosed() 

protected virtual void OnClosed()

OnEndClose(IAsyncResult) 

protected abstract void OnEndClose(IAsyncResult result)

Parameters

result IAsyncResult

OnEndOpen(IAsyncResult) 

protected abstract void OnEndOpen(IAsyncResult result)

Parameters

result IAsyncResult

OnFaulted() 

protected virtual void OnFaulted()

OnOpen(TimeSpan) 

protected virtual void OnOpen(TimeSpan timeout)

Parameters

timeout TimeSpan

OnOpened() 

protected virtual void OnOpened()

ThrowIfClosed() 

protected void ThrowIfClosed()

ThrowIfDisposed() 

protected void ThrowIfDisposed()

ThrowIfDisposedOrImmutable() 

protected void ThrowIfDisposedOrImmutable()

ThrowIfDisposedOrNotOpen() 

protected void ThrowIfDisposedOrNotOpen()

ThrowIfFaulted() 

protected void ThrowIfFaulted()