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

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

Inheritance diagram for PushTechnology.DiffusionCore.Connection.WebSocketServerDetailsImpl:
PushTechnology.DiffusionCore.Connection.ServerDetailsImpl PushTechnology.DiffusionCore.Connection.IServerDetails PushTechnology.DiffusionCore.Connection.WebSocketSSLServerDetailsImpl

Public Member Functions

 WebSocketServerDetailsImpl (string url, TransportProtocol protocol)
 Constructor. More...
 
 WebSocketServerDetailsImpl ()
 Constructor. Defaults connection to port 8080 on localhost. More...
 
 WebSocketServerDetailsImpl (string url)
 Constructor. More...
 
 WebSocketServerDetailsImpl (Uri url)
 Constructor. More...
 
override void SetHostAndPort ()
 Sets the host and port if we're using a url rather than explicit host/port connection details. More...
 
override string ToString ()
 Converts this server details object to a human-readable string. More...
 
string GetOrigin ()
 Return the origin header. More...
 
- Public Member Functions inherited from PushTechnology.DiffusionCore.Connection.ServerDetailsImpl
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...
 
bool IsValidUrl ()
 Determines whether the Url is valid. More...
 
object Clone ()
 Clones this object. More...
 
override string ToString ()
 Returns the string representation of this class. More...
 

Properties

override Uri Url [get, set]
 Get/set the URL. More...
 
- Properties inherited from PushTechnology.DiffusionCore.Connection.ServerDetailsImpl
Guid Id [get, set]
 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...
 
bool TcpNoDelay [get, set]
 The TCP nodelay value. More...
 
virtual Uri Url [get, set]
 Get/set the host name. More...
 
virtual string Host [get, set]
 Get/set the host name. More...
 
virtual 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...
 
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 an object which can be used to handshake with a proxy server More...
 
int OutputBufferSize [get, set]
 Get/set the output buffer size for socket connection buffers. More...
 
long WriteTimeout [get, set]
 The write timeout. More...
 
- Properties inherited from PushTechnology.DiffusionCore.Connection.IServerDetails
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...
 

Additional Inherited Members

- Protected Attributes inherited from PushTechnology.DiffusionCore.Connection.ServerDetailsImpl
Uri theUrl
 The Uniform Resource Identifier. More...
 

Detailed Description

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

Constructor & Destructor Documentation

PushTechnology.DiffusionCore.Connection.WebSocketServerDetailsImpl.WebSocketServerDetailsImpl ( string  url,
TransportProtocol  protocol 
)

Constructor.

Parameters
url
protocol
PushTechnology.DiffusionCore.Connection.WebSocketServerDetailsImpl.WebSocketServerDetailsImpl ( )

Constructor. Defaults connection to port 8080 on localhost.

PushTechnology.DiffusionCore.Connection.WebSocketServerDetailsImpl.WebSocketServerDetailsImpl ( string  url)

Constructor.

Parameters
urlThe url of the server specified as a string.
PushTechnology.DiffusionCore.Connection.WebSocketServerDetailsImpl.WebSocketServerDetailsImpl ( Uri  url)

Constructor.

Parameters
urlThe url of the server.

Member Function Documentation

string PushTechnology.DiffusionCore.Connection.WebSocketServerDetailsImpl.GetOrigin ( )

Return the origin header.

Returns
override void PushTechnology.DiffusionCore.Connection.WebSocketServerDetailsImpl.SetHostAndPort ( )
virtual

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

Reimplemented from PushTechnology.DiffusionCore.Connection.ServerDetailsImpl.

override string PushTechnology.DiffusionCore.Connection.WebSocketServerDetailsImpl.ToString ( )

Converts this server details object to a human-readable string.

Returns

Property Documentation

override Uri PushTechnology.DiffusionCore.Connection.WebSocketServerDetailsImpl.Url
getset

Get/set the URL.