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

The connection capabilities class. More...

Public Member Functions

byte AsByte ()
 Representation of the capabilities byte suitable for sending in a binary format. More...
 
ConnectionCapabilities Remove (ConnectionCapabilities other)
 Remove another ConnectionCapabilities from this one. More...
 
override bool Equals (object obj)
 Determines whether the specified T:System.Object is equal to the current T:System.Object. More...
 
override int GetHashCode ()
 Serves as a hash function for a particular type. More...
 
override string ToString ()
 Returns a string that represents the current object. More...
 

Static Public Attributes

static ConnectionCapabilities NO_CAPABILITIES = new ConnectionCapabilities(0)
 No capabilities. More...
 
static ConnectionCapabilities CLASSIC_ALL_CAPABILITIES
 The capabilities of a fully-fledged classic connection. More...
 
static ConnectionCapabilities UNIFIED_ALL_CAPABILITIES
 The capabilities of a fully-fledged unified API connection. More...
 

Properties

bool CanEncrypt [get]
 Determines whether encryption is possible. More...
 
bool CanCompress [get]
 Determines whether compression is possible. More...
 
bool CanBase64 [get]
 Determines whether base64 encoding is possible. More...
 
bool IsUnifiedApi [get]
 Returns true if the connection is from a unified API client. More...
 

Detailed Description

The connection capabilities class.

Member Function Documentation

byte PushTechnology.DiffusionCore.Connection.ConnectionCapabilities.AsByte ( )

Representation of the capabilities byte suitable for sending in a binary format.

Returns
override bool PushTechnology.DiffusionCore.Connection.ConnectionCapabilities.Equals ( object  obj)

Determines whether the specified T:System.Object is equal to the current T:System.Object.

Returns
true if the specified T:System.Object is equal to the current T:System.Object; otherwise, false.
Parameters
objThe object to compare with the current object.
override int PushTechnology.DiffusionCore.Connection.ConnectionCapabilities.GetHashCode ( )

Serves as a hash function for a particular type.

Returns
A hash code for the current T:System.Object.
ConnectionCapabilities PushTechnology.DiffusionCore.Connection.ConnectionCapabilities.Remove ( ConnectionCapabilities  other)

Remove another ConnectionCapabilities from this one.

Returns a copy of this instance with the given capabilities removed.

Parameters
otherThe object to subtract from this.
Returns
The result of the subtraction.
override string PushTechnology.DiffusionCore.Connection.ConnectionCapabilities.ToString ( )

Returns a string that represents the current object.

Returns
A string that represents the current object.

Member Data Documentation

ConnectionCapabilities PushTechnology.DiffusionCore.Connection.ConnectionCapabilities.CLASSIC_ALL_CAPABILITIES
static
Initial value:
=
new ConnectionCapabilities(CapabilityEncrypt | CapabilityCompress | CapabilityBase64)

The capabilities of a fully-fledged classic connection.

ConnectionCapabilities PushTechnology.DiffusionCore.Connection.ConnectionCapabilities.NO_CAPABILITIES = new ConnectionCapabilities(0)
static

No capabilities.

ConnectionCapabilities PushTechnology.DiffusionCore.Connection.ConnectionCapabilities.UNIFIED_ALL_CAPABILITIES
static
Initial value:
=
new ConnectionCapabilities(
CapabilityEncrypt | CapabilityCompress | CapabilityBase64 | CapabilityUnified)

The capabilities of a fully-fledged unified API connection.

Property Documentation

bool PushTechnology.DiffusionCore.Connection.ConnectionCapabilities.CanBase64
get

Determines whether base64 encoding is possible.

bool PushTechnology.DiffusionCore.Connection.ConnectionCapabilities.CanCompress
get

Determines whether compression is possible.

bool PushTechnology.DiffusionCore.Connection.ConnectionCapabilities.CanEncrypt
get

Determines whether encryption is possible.

bool PushTechnology.DiffusionCore.Connection.ConnectionCapabilities.IsUnifiedApi
get

Returns true if the connection is from a unified API client.