Class NetworkManager

Abstract manager class for network operations.

Inheritance

System.Object

NetworkManager

DesktopNetworkManager

Implements

INetworkManager

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: FellowOakDicom.Network

Assembly: fo-dicom.core.dll

Syntax

public abstract class NetworkManager : INetworkManager

Fields

IPv4Any

String representation of the "Any" IPv4 address, i.e. specifying the listener to listen to all applicable IPv4 addresses.

Declaration

public const string IPv4Any = "0.0.0.0"

Field Value

Type	Description
System.String

IPv4Loopback

String representation of the "Loopback" IPv4 address, i.e. specifying the listener to listen to the local IPv4 host.

Declaration

public const string IPv4Loopback = "127.0.0.1"

Field Value

Type	Description
System.String

IPv6Any

String representation of the "Any" IPv6 address, i.e. specifying the listener to listen to all applicable IPv6 addresses.

Declaration

public const string IPv6Any = "::"

Field Value

Type	Description
System.String

IPv6Loopback

String representation of the "Loopback" IPv6 address, i.e. specifying the listener to listen to the local IPv6 host.

Declaration

public const string IPv6Loopback = "::1"

Field Value

Type	Description
System.String

Properties

MachineNameImpl

Implementation of the machine name getter.

Declaration

protected abstract string MachineNameImpl { get; }

Property Value

Type	Description
System.String

Methods

CreateNetworkListenerImpl(String, Int32)

Platform-specific implementation to create a network listener object.

Declaration

protected abstract INetworkListener CreateNetworkListenerImpl(string ipAddress, int port)

Parameters

Type	Name	Description
System.String	ipAddress	IP address(es) to listen to.
System.Int32	port	Network port to listen to.

Returns

Type	Description
INetworkListener	Network listener implementation.

CreateNetworkStream(TcpClient, ITlsAcceptor, Boolean)

Declaration

public INetworkStream CreateNetworkStream(TcpClient tcpClient, ITlsAcceptor tlsAcceptor, bool ownsTcpClient)

Parameters

Type	Name	Description
System.Net.Sockets.TcpClient	tcpClient
ITlsAcceptor	tlsAcceptor
System.Boolean	ownsTcpClient

Returns

Type	Description
INetworkStream

CreateNetworkStreamImpl(NetworkStreamCreationOptions)

Platform-specific implementation to create a network stream object.

Declaration

protected abstract INetworkStream CreateNetworkStreamImpl(NetworkStreamCreationOptions networkStreamCreationOptions)

Parameters

Type	Name	Description
NetworkStreamCreationOptions	networkStreamCreationOptions

Returns

Type	Description
INetworkStream	Network stream implementation.

CreateNetworkStreamImpl(TcpClient, ITlsAcceptor, Boolean)

Platform-specific implementation to create a network stream object from an existing System.Net.Sockets.TcpClient

Declaration

protected abstract INetworkStream CreateNetworkStreamImpl(TcpClient tcpClient, ITlsAcceptor tlsAcceptor, bool ownsTcpClient)

Parameters

Type	Name	Description
System.Net.Sockets.TcpClient	tcpClient	The inbound, connected TCP client
ITlsAcceptor	tlsAcceptor	The TLS acceptor responsible for setting up TLS
System.Boolean	ownsTcpClient	Whether or not the network stream owns the TCP client (i.e. the TCP client be disposed when the network stream is disposed)

Returns

Type	Description
INetworkStream	Network stream implementation.

IsSocketExceptionImpl(Exception, out Int32, out String)

Platform-specific implementation to check whether specified exception represents a socket exception.

Declaration

protected abstract bool IsSocketExceptionImpl(Exception exception, out int errorCode, out string errorDescriptor)

Parameters

Type	Name	Description
System.Exception	exception	Exception to validate.
System.Int32	errorCode	Error code, valid if exception is socket exception.
System.String	errorDescriptor	Error descriptor, valid if exception is socket exception.

Returns

Type	Description
System.Boolean	True if exception is socket exception, false otherwise.

TryGetNetworkIdentifierImpl(out DicomUID)

Platform-specific implementation to attempt to obtain a unique network identifier, e.g. based on a MAC address.

Declaration

protected abstract bool TryGetNetworkIdentifierImpl(out DicomUID identifier)

Parameters

Type	Name	Description
DicomUID	identifier	Unique network identifier, if found.

Returns

Type	Description
System.Boolean	True if network identifier could be obtained, false otherwise.

Explicit Interface Implementations

INetworkManager.CreateNetworkListener(String, Int32)

Declaration

INetworkListener INetworkManager.CreateNetworkListener(string ipAddress, int port)

Parameters

Type	Name	Description
System.String	ipAddress
System.Int32	port

Returns

Type	Description
INetworkListener

INetworkManager.CreateNetworkStream(NetworkStreamCreationOptions)

Declaration

INetworkStream INetworkManager.CreateNetworkStream(NetworkStreamCreationOptions options)

Parameters

Type	Name	Description
NetworkStreamCreationOptions	options

Returns

Type	Description
INetworkStream

INetworkManager.IsSocketException(Exception, out Int32, out String)

Declaration

bool INetworkManager.IsSocketException(Exception exception, out int errorCode, out string errorDescriptor)

Parameters

Type	Name	Description
System.Exception	exception
System.Int32	errorCode
System.String	errorDescriptor

Returns

Type	Description
System.Boolean

INetworkManager.MachineName

Declaration

string INetworkManager.MachineName { get; }

Returns

Type	Description
System.String

INetworkManager.TryGetNetworkIdentifier(out DicomUID)

Declaration

bool INetworkManager.TryGetNetworkIdentifier(out DicomUID identifier)

Parameters

Type	Name	Description
DicomUID	identifier

Returns

Type	Description
System.Boolean

Implements

INetworkManager

Extension Methods

LinqExtensions.IsOneOf<T>(T, T[])