public interface IProtocol

Known direct subtypes: ProtocolBase

Summary

Object describing various overarching parameters associated with a particular AMQP protocol variant.

Property Summary

Type Name Summary
string ApiName (r)

Retrieve the protocol's API name, used for printing, configuration properties, IDE integration, Protocols.cs etc.

int DefaultPort (r)

Retrieve the protocol's default TCP port.

int MajorVersion (r)

Retrieve the protocol's major version number.

int MinorVersion (r)

Retrieve the protocol's minor version number.

int Revision (r)

Retrieve the protocol's revision (if specified).

Method Summary

Name Summary
IConnection CreateConnection(IConnectionFactory factory, bool insist, IFrameHandler frameHandler)

Construct a connection from a given set of parameters, a frame handler, and no automatic recovery. The "insist" parameter is passed on to the AMQP connection.open method.

IConnection CreateConnection(ConnectionFactory factory, IFrameHandler frameHandler, bool automaticRecoveryEnabled)

Construct a connection from a given set of parameters, a frame handler, and automatic recovery settings.

IFrameHandler CreateFrameHandler(AmqpTcpEndpoint endpoint, Func<AddressFamily,ITcpClient> socketFactory, int connectionTimeout, int readTimeout, int writeTimeout)

Construct a frame handler for a given endpoint.

IModel CreateModel(ISession session)

Construct a protocol model atop a given session.

Property Detail

string ApiName (r)

Summary

Retrieve the protocol's API name, used for printing, configuration properties, IDE integration, Protocols.cs etc.

int DefaultPort (r)

Summary

Retrieve the protocol's default TCP port.

int MajorVersion (r)

Summary

Retrieve the protocol's major version number.

int MinorVersion (r)

Summary

Retrieve the protocol's minor version number.

int Revision (r)

Summary

Retrieve the protocol's revision (if specified).

Method Detail

CreateConnection

IConnection CreateConnection(IConnectionFactory factory, bool insist, IFrameHandler frameHandler)

Return type IConnection
Parameters
Name Type
factory IConnectionFactory
insist bool
frameHandler IFrameHandler

Summary

Construct a connection from a given set of parameters, a frame handler, and no automatic recovery. The "insist" parameter is passed on to the AMQP connection.open method.

CreateConnection

IConnection CreateConnection(ConnectionFactory factory, IFrameHandler frameHandler, bool automaticRecoveryEnabled)

Return type IConnection
Parameters
Name Type
factory ConnectionFactory
frameHandler IFrameHandler
automaticRecoveryEnabled bool

Summary

Construct a connection from a given set of parameters, a frame handler, and automatic recovery settings.

CreateFrameHandler

IFrameHandler CreateFrameHandler(AmqpTcpEndpoint endpoint, Func<AddressFamily,ITcpClient> socketFactory, int connectionTimeout, int readTimeout, int writeTimeout)

Return type IFrameHandler
Parameters
Name Type
endpoint AmqpTcpEndpoint
socketFactory Func<AddressFamily,ITcpClient>
connectionTimeout int
readTimeout int
writeTimeout int

Summary

Construct a frame handler for a given endpoint.

Param

Socket factory method.

Param

Timeout in milliseconds.

Param

Represents a TCP-addressable AMQP peer: a host name and port number.

CreateModel

IModel CreateModel(ISession session)

Return type IModel
Parameters
Name Type
session ISession

Summary

Construct a protocol model atop a given session.