Index | Namespace RabbitMQ.Client

public interface IProtocol

Known direct subtypes: AbstractProtocolBase

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
bool DefaultSuppressAccessRequest (r)

Returns false if this protocol variant defaults to permitting Access.Requests to be sent to the peer, or true if Access.Requests should be suppressed by default.
int MajorVersion (r)

Retrieve the protocol's major version number
int MinorVersion (r)

Retrieve the protocol's minor version number

Method Summary

Name Summary
IConnection CreateConnection(ConnectionParameters parameters, bool insist, IFrameHandler frameHandler)

Construct a connection from a given set of parameters and a frame handler. The "insist" parameter is passed on to the AMQP connection.open method.
IFrameHandler CreateFrameHandler(AmqpTcpEndpoint endpoint)

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

bool DefaultSuppressAccessRequest (r)

Summary

Returns false if this protocol variant defaults to permitting Access.Requests to be sent to the peer, or true if Access.Requests should be suppressed by default.

int MajorVersion (r)

Summary

Retrieve the protocol's major version number

int MinorVersion (r)

Summary

Retrieve the protocol's minor version number

Method Detail

CreateConnection

IConnection CreateConnection(ConnectionParameters parameters, bool insist, IFrameHandler frameHandler)

Return type IConnection
Parameters
Name Type
parameters ConnectionParameters
insist bool
frameHandler IFrameHandler

Summary

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

CreateFrameHandler

IFrameHandler CreateFrameHandler(AmqpTcpEndpoint endpoint)

Return type IFrameHandler
Parameters
Name Type
endpoint AmqpTcpEndpoint

Summary

Construct a frame handler for a given endpoint.

CreateModel

IModel CreateModel(ISession session)

Return type IModel
Parameters
Name Type
session ISession

Summary

Construct a protocol model atop a given session.