Diffusion .NET Classic API - Core and Common  5.9.4
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
PushTechnology.DiffusionCore.Connection.IServerDetails Interface Reference

Defines the details of a connection to a Diffusion server. More...

Inheritance diagram for PushTechnology.DiffusionCore.Connection.IServerDetails:
PushTechnology.DiffusionCore.Connection.ServerDetailsImpl PushTechnology.DiffusionCore.Connection.HttpServerDetailsImpl PushTechnology.DiffusionCore.Connection.TcpServerDetailsImpl PushTechnology.DiffusionCore.Connection.WebSocketServerDetailsImpl PushTechnology.DiffusionCore.Connection.HttpSslServerDetailsImpl PushTechnology.DiffusionCore.Connection.TcpSslServerDetailsImpl PushTechnology.DiffusionCore.Connection.WebSocketSSLServerDetailsImpl

Public Member Functions

void SetTopics (TopicSet topics)
 Sets the topic(s) to be subscribed to on connection. More...
 
void SetTopics (params string[] topics)
 Sets the default topic(s) to be subscribed on connection. More...
 
TopicSet GetTopics ()
 Returns the default list of topics to subscribe to on connection. More...
 
void SetHostAndPort ()
 Sets the host and port if we're using a url rather than explicit host/port connection details. More...
 
bool IsValidUrl ()
 Determines whether the Url is valid. More...
 
object Clone ()
 Clones this object. More...
 

Properties

Guid Id [get]
 The unique id of these server details. More...
 
int ConnectionTimeout [get, set]
 The timeout for connection attempts (in milliseconds). More...
 
TransportProtocol Protocol [get, set]
 The transport protocol being used. More...
 
int TcpKeepAliveInterval [get, set]
 The TCP keepalive interval (in milliseconds). More...
 
Uri Url [get, set]
 Get/set the host name. More...
 
string Host [get, set]
 Get/set the host name. More...
 
int Port [get, set]
 Get/set the port number. More...
 
IPEndPoint LocalSocketAddress [get, set]
 Get/set the (optional) local socket address - used prior to connection. More...
 
V4Credentials Credentials [get, set]
 Get/set the credentials to be used. More...
 
string Name [get, set]
 This is used as a helper when persisting properties for the Test Tool. More...
 
string UserName [get, set]
 Credentials - user name. More...
 
string Password [get, set]
 Credentials - password. More...
 
bool AutoAcknowledge [get, set]
 Automatically acknowledge messages. More...
 
int InputBufferSize [get, set]
 Get/set the input buffer size for socket connection buffers. More...
 
int OutputBufferSize [get, set]
 Get/set the output buffer size for socket connection buffers. More...
 
long WriteTimeout [get, set]
 The write timeout. More...
 
bool IsSecure [get, set]
 Get/set whether this is a secure connection type. More...
 
RemoteCertificateValidationCallback RemoteCertificateValidationCallback [get, set]
 Get/set a callback to use to validate a remote certificate More...
 
LocalCertificateSelectionCallback LocalCertificateSelectionCallback [get, set]
 Get/set a callback to use to select a client certificate More...
 
IProxyConnector ProxyConnector [get, set]
 Get/set the proxy connector object. More...
 
bool TcpNoDelay [get, set]
 Get/set the TCP nodelay value. More...
 

Detailed Description

Defines the details of a connection to a Diffusion server.

Server details objects are created using ConnectionFactory.CreateServerDetails( string ).

Member Function Documentation

object PushTechnology.DiffusionCore.Connection.IServerDetails.Clone ( )

Clones this object.

Returns

Implemented in PushTechnology.DiffusionCore.Connection.ServerDetailsImpl.

TopicSet PushTechnology.DiffusionCore.Connection.IServerDetails.GetTopics ( )

Returns the default list of topics to subscribe to on connection.

Returns

Implemented in PushTechnology.DiffusionCore.Connection.ServerDetailsImpl.

bool PushTechnology.DiffusionCore.Connection.IServerDetails.IsValidUrl ( )

Determines whether the Url is valid.

Returns

Implemented in PushTechnology.DiffusionCore.Connection.ServerDetailsImpl.

void PushTechnology.DiffusionCore.Connection.IServerDetails.SetHostAndPort ( )

Sets the host and port if we're using a url rather than explicit host/port connection details.

Implemented in PushTechnology.DiffusionCore.Connection.ServerDetailsImpl, and PushTechnology.DiffusionCore.Connection.WebSocketServerDetailsImpl.

void PushTechnology.DiffusionCore.Connection.IServerDetails.SetTopics ( TopicSet  topics)

Sets the topic(s) to be subscribed to on connection.

If not explicitly set then no topics are subscribed to by default on connection.

Parameters
topicsThe topics to use by default, or null to indicate that no topics are to be subscribed to on connection (the default).

Implemented in PushTechnology.DiffusionCore.Connection.ServerDetailsImpl.

void PushTechnology.DiffusionCore.Connection.IServerDetails.SetTopics ( params string[]  topics)

Sets the default topic(s) to be subscribed on connection.

This is a convenience method equivalent to calling SetTopics( TopicSet ) with a TopicSet.

Parameters
topicsOne or more topic names or selection patterns.

Implemented in PushTechnology.DiffusionCore.Connection.ServerDetailsImpl.

Property Documentation

bool PushTechnology.DiffusionCore.Connection.IServerDetails.AutoAcknowledge
getset

Automatically acknowledge messages.

int PushTechnology.DiffusionCore.Connection.IServerDetails.ConnectionTimeout
getset

The timeout for connection attempts (in milliseconds).

V4Credentials PushTechnology.DiffusionCore.Connection.IServerDetails.Credentials
getset

Get/set the credentials to be used.

string PushTechnology.DiffusionCore.Connection.IServerDetails.Host
getset

Get/set the host name.

Guid PushTechnology.DiffusionCore.Connection.IServerDetails.Id
get

The unique id of these server details.

int PushTechnology.DiffusionCore.Connection.IServerDetails.InputBufferSize
getset

Get/set the input buffer size for socket connection buffers.

bool PushTechnology.DiffusionCore.Connection.IServerDetails.IsSecure
getset

Get/set whether this is a secure connection type.

LocalCertificateSelectionCallback PushTechnology.DiffusionCore.Connection.IServerDetails.LocalCertificateSelectionCallback
getset

Get/set a callback to use to select a client certificate

IPEndPoint PushTechnology.DiffusionCore.Connection.IServerDetails.LocalSocketAddress
getset

Get/set the (optional) local socket address - used prior to connection.

string PushTechnology.DiffusionCore.Connection.IServerDetails.Name
getset

This is used as a helper when persisting properties for the Test Tool.

int PushTechnology.DiffusionCore.Connection.IServerDetails.OutputBufferSize
getset

Get/set the output buffer size for socket connection buffers.

string PushTechnology.DiffusionCore.Connection.IServerDetails.Password
getset

Credentials - password.

int PushTechnology.DiffusionCore.Connection.IServerDetails.Port
getset

Get/set the port number.

TransportProtocol PushTechnology.DiffusionCore.Connection.IServerDetails.Protocol
getset

The transport protocol being used.

IProxyConnector PushTechnology.DiffusionCore.Connection.IServerDetails.ProxyConnector
getset

Get/set the proxy connector object.

RemoteCertificateValidationCallback PushTechnology.DiffusionCore.Connection.IServerDetails.RemoteCertificateValidationCallback
getset

Get/set a callback to use to validate a remote certificate

int PushTechnology.DiffusionCore.Connection.IServerDetails.TcpKeepAliveInterval
getset

The TCP keepalive interval (in milliseconds).

bool PushTechnology.DiffusionCore.Connection.IServerDetails.TcpNoDelay
getset

Get/set the TCP nodelay value.

Uri PushTechnology.DiffusionCore.Connection.IServerDetails.Url
getset

Get/set the host name.

string PushTechnology.DiffusionCore.Connection.IServerDetails.UserName
getset

Credentials - user name.

long PushTechnology.DiffusionCore.Connection.IServerDetails.WriteTimeout
getset

The write timeout.