Interface INetworkManager

Namespace: FellowOakDicom.Network
Assembly: fo-dicom.core.dll
Syntax
public interface INetworkManager

Properties

MachineName

Gets the machine name

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

Methods

CreateNetworkListener(String, Int32)

Platform-specific implementation to create a network listener object.

Declaration
INetworkListener CreateNetworkListener(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(NetworkStreamCreationOptions)

Platform-specific implementation to create a network stream object.

Declaration
INetworkStream CreateNetworkStream(NetworkStreamCreationOptions options)
Parameters
Type Name Description
NetworkStreamCreationOptions options

The various options that specify how the network stream must be created
Returns
Type Description
INetworkStream

Network stream implementation.

CreateNetworkStream(TcpClient, ITlsAcceptor, Boolean)

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

Declaration
INetworkStream CreateNetworkStream(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.

IsSocketException(Exception, out Int32, out String)

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

Declaration
bool IsSocketException(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.

TryGetNetworkIdentifier(out DicomUID)

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

Declaration
bool TryGetNetworkIdentifier(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.

Extension Methods