CodedSocketException Class

[This is preliminary documentation and is subject to change.]

The exception that is thrown when a socket error occurs. This exception provides constructors to set custom HResult values.

Inheritance Hierarchy

SystemObject
  SystemException
    NerdyDuck.CodedExceptionsCodedException
      NerdyDuck.CodedExceptionsCodedSocketException

Namespace: NerdyDuck.CodedExceptions
Assembly: NerdyDuck.CodedExceptions (in NerdyDuck.CodedExceptions.dll) Version: 2.0.0+2040dad

Syntax

Copy

[SerializableAttribute]
[CodedExceptionAttribute]
public class CodedSocketException : CodedException

<SerializableAttribute>
<CodedExceptionAttribute>
Public Class CodedSocketException
	Inherits CodedException

View Source

The CodedSocketException type exposes the following members.

Constructors

	Name	Description
	CodedSocketException	Initializes a new instance of the CodedSocketException class.
	CodedSocketException(Int32)	Initializes a new instance of the CodedSocketException class with a specified HRESULT value.
	CodedSocketException(SocketError)	Initializes a new instance of the CodedSocketException class with the specified error code.
	CodedSocketException(String)	Initializes a new instance of the CodedSocketException class with a specified error message.
	CodedSocketException(Int32, SocketError)	Initializes a new instance of the CodedSocketException class with a specified HRESULT value and socket error code.
	CodedSocketException(Int32, String)	Initializes a new instance of the CodedSocketException class with a specified HRESULT value and error message.
	CodedSocketException(SocketError, String)	Initializes a new instance of the CodedSocketException class with a specified error message.
	CodedSocketException(SerializationInfo, StreamingContext)	Initializes a new instance of the CodedSocketException class with serialized data.
	CodedSocketException(String, Exception)	Initializes a new instance of the CodedSocketException class with a specified error message and a reference to the inner exception that is the cause of this exception.
	CodedSocketException(Int32, SocketError, String)	Initializes a new instance of the CodedSocketException class with a specified HRESULT value, socket error code and error message.
	CodedSocketException(Int32, String, Exception)	Initializes a new instance of the CodedSocketException class with a specified HRESULT value, error message and a reference to the inner exception that is the cause of this exception.
	CodedSocketException(SocketError, String, Exception)	Initializes a new instance of the CodedSocketException class with a specified error message and a reference to the inner exception that is the cause of this exception.
	CodedSocketException(Int32, SocketError, String, Exception)	Initializes a new instance of the CodedSocketException class with a specified HRESULT value, socket error code, error message and a reference to the inner exception that is the cause of this exception.

Top

Properties

	Name	Description
	Data	Gets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception.)
	HelpLink	Gets or sets a link to the help file associated with this exception. (Inherited from Exception.)
	HResult	Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception. (Inherited from Exception.)
	InnerException	Gets the Exception instance that caused the current exception. (Inherited from Exception.)
	Message	Gets a message that describes the current exception. (Inherited from Exception.)
	SocketErrorCode	Gets the error code that is associated with this exception.
	Source	Gets or sets the name of the application or the object that causes the error. (Inherited from Exception.)
	StackTrace	Gets a string representation of the immediate frames on the call stack. (Inherited from Exception.)
	TargetSite	Gets the method that throws the current exception. (Inherited from Exception.)

Top

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetBaseException	When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions. (Inherited from Exception.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetObjectData	Sets the SerializationInfo with information about the exception. (Overrides ExceptionGetObjectData(SerializationInfo, StreamingContext).)
	GetType	Gets the runtime type of the current instance. (Inherited from Exception.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ToString	Returns the fully qualified name of this exception, the HResult and possibly the error message, the name of the inner exception, and the stack trace. (Overrides CodedExceptionToString.)

Top

Events

	Name	Description
	SerializeObjectState	Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception. (Inherited from Exception.)

Top

Extension Methods

	Name	Description
	GetErrorId	Gets the error identifier part of a HResult. (Defined by ExceptionExtensions.)
	GetFacilityId	Gets the facility (= the assembly) identifier part of an HResult. (Defined by ExceptionExtensions.)
	IsCodedException	Checks if the type of the specified instance of Exception or a derived class has a CodedExceptionAttribute. (Defined by ExceptionExtensions.)
	IsCustomHResult	Checks if the HResult of the exception is a custom error value. (Defined by ExceptionExtensions.)

Top

Remarks

This exception is not derived from SocketException, because that class provides only a minimum of constructors.

Reference

NerdyDuck.CodedExceptions Namespace