Show / Hide Table of Contents

Class Address

Defines the address of an AMQP endpoint.

Inheritance
System.Object
Address
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Amqp
Assembly: Amqp.Net.dll
Syntax
public sealed class Address
Remarks

An address has the following form:

amqp[s] :// [user:[password]@] domain[:port] [/[path]

Where domain can be:

host | ip | name

If "amqps" is specified, the connection uses TLS in the underlying transport. When port is not specified, it is set to the standard based on scheme (amqp: 5672, amqps: 5671) path is not used by the library. Note that TLS Server Name Indication (SNI) is signaled only for "amqps" addresses where the domain is host | name. SNI is not signaled when the domain is a numeric IP address.

Constructors

Address(String)

Initializes a new instance of the Address class from a string.

Declaration
public Address(string address)
Parameters
Type Name Description
System.String address

The string representation of the address.

Address(String, Int32, String, String, String, String)

Initializes a new instance of the Address class from individual components.

Declaration
public Address(string host, int port, string user = null, string password = null, string path = "/", string scheme = "AMQPS")
Parameters
Type Name Description
System.String host

The domain of the address.

System.Int32 port

The port number of the address.

System.String user

User name for SASL PLAIN profile.

System.String password

Password for SASL PLAIN profile.

System.String path

The path of the address.

System.String scheme

Protocol scheme, which can be either "amqp" or "amqps".

Properties

Host

Gets the host of the address.

Declaration
public string Host { get; }
Property Value
Type Description
System.String

Password

Gets the password that is used for SASL PLAIN profile.

Declaration
public string Password { get; }
Property Value
Type Description
System.String

Path

Gets the path of the address.

Declaration
public string Path { get; }
Property Value
Type Description
System.String

Port

Gets the port number of the address.

Declaration
public int Port { get; }
Property Value
Type Description
System.Int32

Scheme

Gets the protocol scheme.

Declaration
public string Scheme { get; }
Property Value
Type Description
System.String

User

Gets the user name that is used for SASL PLAIN profile.

Declaration
public string User { get; }
Property Value
Type Description
System.String

UseSsl

Gets a value indicating where TLS is enabled.

Declaration
public bool UseSsl { get; }
Property Value
Type Description
System.Boolean
Back to top Copyright © 2015-2017 Microsoft
Generated by DocFX