C# Class RabbitMQ.Client.Framing.Impl.Connection

Inheritance: IConnection
Afficher le fichier Open project: rabbitmq/rabbitmq-dotnet-client Class Usage Examples

Private Properties

Свойство Type Description
IDisposable void
MaybeDisposeTimer void
NegotiatedMaxValue uint

Méthodes publiques

Méthode Description
Abort ( ) : void

API-side invocation of connection abort.
Abort ( int timeout ) : void

API-side invocation of connection abort with timeout.
Abort ( ushort reasonCode, string reasonText ) : void

API-side invocation of connection abort.
Abort ( ushort reasonCode, string reasonText, ShutdownInitiator initiator, int timeout ) : void
Abort ( ushort reasonCode, string reasonText, int timeout ) : void

API-side invocation of connection abort with timeout.
Close ( ) : void

API-side invocation of connection.close.
Close ( ShutdownEventArgs reason ) : void
Close ( ShutdownEventArgs reason, bool abort, int timeout ) : void

Try to close connection in a graceful way

Shutdown reason contains code and text assigned when closing the connection, as well as the information about what initiated the close

Abort flag, if true, signals to close the ongoing connection immediately and do not report any errors if it was already closed.

Timeout determines how much time internal close operations should be given to complete. Negative or Timeout.Infinite value mean infinity.

Close ( int timeout ) : void

API-side invocation of connection.close with timeout.
Close ( ushort reasonCode, string reasonText ) : void

API-side invocation of connection.close.
Close ( ushort reasonCode, string reasonText, int timeout ) : void

API-side invocation of connection.close with timeout.
ClosingLoop ( ) : void Loop only used while quiescing. Use only to cleanly close connection
Connection ( IConnectionFactory factory, bool insist, IFrameHandler frameHandler, string clientProvidedName = null ) : System.Threading.Tasks
ConnectionCloseWrapper ( ushort reasonCode, string reasonText ) : Command
CreateModel ( ) : IModel
CreateSession ( ) : ISession
CreateSession ( int channelNumber ) : ISession
DefaultClientProperties ( ) : object>.IDictionary
EnsureIsOpen ( ) : void
FinishClose ( ) : void
HandleApplicationSuspend ( object sender, SuspendingEventArgs suspendingEventArgs ) : void We need to close the socket, otherwise suspending the application will take the maximum time allowed
HandleConnectionBlocked ( string reason ) : void
HandleConnectionUnblocked ( ) : void
HandleDomainUnload ( object sender, EventArgs ea ) : void We need to close the socket, otherwise attempting to unload the domain could cause a CannotUnloadAppDomainException
HandleMainLoopException ( ShutdownEventArgs reason ) : void
HardProtocolExceptionHandler ( RabbitMQ.Client.Impl.HardProtocolException hpe ) : bool
HeartbeatReadTimerCallback ( object state ) : void
HeartbeatWriteTimerCallback ( object state ) : void
InternalClose ( ShutdownEventArgs reason ) : void
LogCloseError ( String error, Exception ex ) : void
MainLoop ( ) : void
MainLoopIteration ( ) : void
MaybeStartHeartbeatTimers ( ) : void
NotifyHeartbeatListener ( ) : void
NotifyReceivedCloseOk ( ) : void
OnCallbackException ( RabbitMQ.Client.Events.CallbackExceptionEventArgs args ) : void
OnConnectionBlocked ( RabbitMQ.Client.Events.ConnectionBlockedEventArgs args ) : void
OnConnectionUnblocked ( ) : void
OnShutdown ( ) : void

Broadcasts notification of the final shutdown of the connection.
Open ( bool insist ) : void
PrettyPrintShutdownReport ( ) : void
QuiesceChannel ( RabbitMQ.Client.Impl.SoftProtocolException pe ) : void

Sets the channel named in the SoftProtocolException into "quiescing mode", where we issue a channel.close and ignore everything except for subsequent channel.close messages and the channel.close-ok reply that should eventually arrive.

Since a well-behaved peer will not wait indefinitely before issuing the close-ok, we don't bother with a timeout here; compare this to the case of a connection.close-ok, where a timeout is necessary.

We need to send the close method and politely wait for a reply before marking the channel as available for reuse.

As soon as SoftProtocolException is detected, we should stop servicing ordinary application work, and should concentrate on bringing down the channel as quickly and gracefully as possible. The way this is done, as per the close-protocol, is to signal closure up the stack *before* sending the channel.close, by invoking ISession.Close. Once the upper layers have been signalled, we are free to do what we need to do to clean up and shut down the channel.

SetCloseReason ( ShutdownEventArgs reason ) : bool
StartMainLoop ( bool useBackgroundThread ) : void
TerminateMainloop ( ) : void May be called more than once. Should therefore be idempotent.
ToString ( ) : string
WriteFrame ( Frame f ) : void
WriteFrameSet ( IList f ) : void

Méthodes protégées

Méthode Description
ChannelCloseWrapper ( ushort reasonCode, string reasonText ) : Command
MaybeStopHeartbeatTimers ( ) : void
StartAndTune ( ) : void

Private Methods

Méthode Description
IDisposable ( ) : void
MaybeDisposeTimer ( Timer &timer ) : void
NegotiatedMaxValue ( uint clientValue, uint serverValue ) : uint

Method Details

Abort() public méthode

API-side invocation of connection abort.
public Abort ( ) : void
Résultat void

Abort() public méthode

API-side invocation of connection abort with timeout.
public Abort ( int timeout ) : void
timeout int
Résultat void

Abort() public méthode

API-side invocation of connection abort.
public Abort ( ushort reasonCode, string reasonText ) : void
reasonCode ushort
reasonText string
Résultat void

Abort() public méthode

public Abort ( ushort reasonCode, string reasonText, ShutdownInitiator initiator, int timeout ) : void
reasonCode ushort
reasonText string
initiator ShutdownInitiator
timeout int
Résultat void

Abort() public méthode

API-side invocation of connection abort with timeout.
public Abort ( ushort reasonCode, string reasonText, int timeout ) : void
reasonCode ushort
reasonText string
timeout int
Résultat void

ChannelCloseWrapper() protected méthode

protected ChannelCloseWrapper ( ushort reasonCode, string reasonText ) : Command
reasonCode ushort
reasonText string
Résultat RabbitMQ.Client.Impl.Command

Close() public méthode

API-side invocation of connection.close.
public Close ( ) : void
Résultat void

Close() public méthode

public Close ( ShutdownEventArgs reason ) : void
reason ShutdownEventArgs
Résultat void

Close() public méthode

Try to close connection in a graceful way

Shutdown reason contains code and text assigned when closing the connection, as well as the information about what initiated the close

Abort flag, if true, signals to close the ongoing connection immediately and do not report any errors if it was already closed.

Timeout determines how much time internal close operations should be given to complete. Negative or Timeout.Infinite value mean infinity.

public Close ( ShutdownEventArgs reason, bool abort, int timeout ) : void
reason ShutdownEventArgs
abort bool
timeout int
Résultat void

Close() public méthode

API-side invocation of connection.close with timeout.
public Close ( int timeout ) : void
timeout int
Résultat void

Close() public méthode

API-side invocation of connection.close.
public Close ( ushort reasonCode, string reasonText ) : void
reasonCode ushort
reasonText string
Résultat void

Close() public méthode

API-side invocation of connection.close with timeout.
public Close ( ushort reasonCode, string reasonText, int timeout ) : void
reasonCode ushort
reasonText string
timeout int
Résultat void

ClosingLoop() public méthode

Loop only used while quiescing. Use only to cleanly close connection
public ClosingLoop ( ) : void
Résultat void

Connection() public méthode

public Connection ( IConnectionFactory factory, bool insist, IFrameHandler frameHandler, string clientProvidedName = null ) : System.Threading.Tasks
factory IConnectionFactory
insist bool
frameHandler IFrameHandler
clientProvidedName string
Résultat System.Threading.Tasks

ConnectionCloseWrapper() public méthode

public ConnectionCloseWrapper ( ushort reasonCode, string reasonText ) : Command
reasonCode ushort
reasonText string
Résultat RabbitMQ.Client.Impl.Command

CreateModel() public méthode

public CreateModel ( ) : IModel
Résultat IModel

CreateSession() public méthode

public CreateSession ( ) : ISession
Résultat ISession

CreateSession() public méthode

public CreateSession ( int channelNumber ) : ISession
channelNumber int
Résultat ISession

DefaultClientProperties() public static méthode

public static DefaultClientProperties ( ) : object>.IDictionary
Résultat object>.IDictionary

EnsureIsOpen() public méthode

public EnsureIsOpen ( ) : void
Résultat void

FinishClose() public méthode

public FinishClose ( ) : void
Résultat void

HandleApplicationSuspend() public méthode

We need to close the socket, otherwise suspending the application will take the maximum time allowed
public HandleApplicationSuspend ( object sender, SuspendingEventArgs suspendingEventArgs ) : void
sender object
suspendingEventArgs Windows.ApplicationModel.SuspendingEventArgs
Résultat void

HandleConnectionBlocked() public méthode

public HandleConnectionBlocked ( string reason ) : void
reason string
Résultat void

HandleConnectionUnblocked() public méthode

public HandleConnectionUnblocked ( ) : void
Résultat void

HandleDomainUnload() public méthode

We need to close the socket, otherwise attempting to unload the domain could cause a CannotUnloadAppDomainException
public HandleDomainUnload ( object sender, EventArgs ea ) : void
sender object
ea System.EventArgs
Résultat void

HandleMainLoopException() public méthode

public HandleMainLoopException ( ShutdownEventArgs reason ) : void
reason ShutdownEventArgs
Résultat void

HardProtocolExceptionHandler() public méthode

public HardProtocolExceptionHandler ( RabbitMQ.Client.Impl.HardProtocolException hpe ) : bool
hpe RabbitMQ.Client.Impl.HardProtocolException
Résultat bool

HeartbeatReadTimerCallback() public méthode

public HeartbeatReadTimerCallback ( object state ) : void
state object
Résultat void

HeartbeatWriteTimerCallback() public méthode

public HeartbeatWriteTimerCallback ( object state ) : void
state object
Résultat void

InternalClose() public méthode

public InternalClose ( ShutdownEventArgs reason ) : void
reason ShutdownEventArgs
Résultat void

LogCloseError() public méthode

public LogCloseError ( String error, Exception ex ) : void
error String
ex System.Exception
Résultat void

MainLoop() public méthode

public MainLoop ( ) : void
Résultat void

MainLoopIteration() public méthode

public MainLoopIteration ( ) : void
Résultat void

MaybeStartHeartbeatTimers() public méthode

public MaybeStartHeartbeatTimers ( ) : void
Résultat void

MaybeStopHeartbeatTimers() protected méthode

protected MaybeStopHeartbeatTimers ( ) : void
Résultat void

NotifyHeartbeatListener() public méthode

public NotifyHeartbeatListener ( ) : void
Résultat void

NotifyReceivedCloseOk() public méthode

public NotifyReceivedCloseOk ( ) : void
Résultat void

OnCallbackException() public méthode

public OnCallbackException ( RabbitMQ.Client.Events.CallbackExceptionEventArgs args ) : void
args RabbitMQ.Client.Events.CallbackExceptionEventArgs
Résultat void

OnConnectionBlocked() public méthode

public OnConnectionBlocked ( RabbitMQ.Client.Events.ConnectionBlockedEventArgs args ) : void
args RabbitMQ.Client.Events.ConnectionBlockedEventArgs
Résultat void

OnConnectionUnblocked() public méthode

public OnConnectionUnblocked ( ) : void
Résultat void

OnShutdown() public méthode

Broadcasts notification of the final shutdown of the connection.
public OnShutdown ( ) : void
Résultat void

Open() public méthode

public Open ( bool insist ) : void
insist bool
Résultat void

PrettyPrintShutdownReport() public méthode

public PrettyPrintShutdownReport ( ) : void
Résultat void

QuiesceChannel() public méthode

Sets the channel named in the SoftProtocolException into "quiescing mode", where we issue a channel.close and ignore everything except for subsequent channel.close messages and the channel.close-ok reply that should eventually arrive.

Since a well-behaved peer will not wait indefinitely before issuing the close-ok, we don't bother with a timeout here; compare this to the case of a connection.close-ok, where a timeout is necessary.

We need to send the close method and politely wait for a reply before marking the channel as available for reuse.

As soon as SoftProtocolException is detected, we should stop servicing ordinary application work, and should concentrate on bringing down the channel as quickly and gracefully as possible. The way this is done, as per the close-protocol, is to signal closure up the stack *before* sending the channel.close, by invoking ISession.Close. Once the upper layers have been signalled, we are free to do what we need to do to clean up and shut down the channel.

public QuiesceChannel ( RabbitMQ.Client.Impl.SoftProtocolException pe ) : void
pe RabbitMQ.Client.Impl.SoftProtocolException
Résultat void

SetCloseReason() public méthode

public SetCloseReason ( ShutdownEventArgs reason ) : bool
reason ShutdownEventArgs
Résultat bool

StartAndTune() protected méthode

protected StartAndTune ( ) : void
Résultat void

StartMainLoop() public méthode

public StartMainLoop ( bool useBackgroundThread ) : void
useBackgroundThread bool
Résultat void

TerminateMainloop() public méthode

May be called more than once. Should therefore be idempotent.
public TerminateMainloop ( ) : void
Résultat void

ToString() public méthode

public ToString ( ) : string
Résultat string

WriteFrame() public méthode

public WriteFrame ( Frame f ) : void
f RabbitMQ.Client.Impl.Frame
Résultat void

WriteFrameSet() public méthode

public WriteFrameSet ( IList f ) : void
f IList
Résultat void