Asposecpplib
System::Net::Sockets::Details_SocketException Class Reference

Represents the exception thrown when a socket error occurs. Never create instances of this class manually. Use the SocketException class instead. Never wrap the SocketException class instances into System::SmartPtr. More...

Inherits System::Details_Exception.

Public Member Functions

void set_ErrorCode (int32_t code)
 Sets the error code. More...
 
int32_t get_ErrorCode ()
 Gets the error code. More...
 
SocketError get_SocketErrorCode ()
 Gets the socket error code. More...
 
void set_SocketErrorCode (SocketError socketError)
 Sets the socket error code. More...
 
- Public Member Functions inherited from System::Details_Exception
virtual String get_Message () const
 Returns the string containing the error destcription. More...
 
virtual String get_StackTrace () const
 Returns the string containing the stack trace. More...
 
virtual ExceptionWrapper< Details_Exceptionget_InnerException () const
 Returns a reference to the object representing the inner exception. More...
 
virtual ExceptionWrapper< Details_ExceptionGetBaseException () const
 Returns the copy of Exception object representing the inner-most exception. More...
 
int32_t get_HResult () const
 Returns a 32-bit integer value which is a HRESULT code associated with the exception reprsented by the current object. More...
 
void set_HResult (int32_t value)
 Sets HRESULT, a coded numerical value that is assigned to a specific exception. More...
 
virtual String ToString () const override
 Returns the string representation of the current object. More...
 
virtual const char * what () const noexcept
 Implements what() method which is called by ExceptionWrapper class. Despite of the fact that this class is not inherited from std::exception derived classes can use protected/private members to implement their logic. Moving this method implementation to the ExceptionWrapper may broke that logic. More...
 
- Public Member Functions inherited from System::Object
 Object ()
 Creates object. Initializes all internal data structures. More...
 
virtual ~Object ()
 Destroys object. Frees all internal data structures. More...
 
 Object (Object const &x)
 Copy constructor. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
Objectoperator= (Object const &x)
 Assignment operator. Doesn't copy anything, really, just initializes new object and enables copy constructing subclasses. More...
 
ObjectSharedRefAdded ()
 Increments shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int SharedRefRemovedSafe ()
 Decrements and returns shared reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
int RemovedSharedRefs (int count)
 Decreases shared reference count by specified value. More...
 
Detail::SmartPtrCounter * WeakRefAdded ()
 Increments weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
void WeakRefRemoved ()
 Decrements weak reference count. Shouldn't be called directly; instead, use smart pointers or ThisProtector. More...
 
Detail::SmartPtrCounter * GetCounter ()
 Gets reference counter data structure associated with the object. More...
 
int SharedCount () const
 Gets current value of shared reference counter. More...
 
void Lock ()
 Implements C# lock() statement locking. Call directly or use LockContext sentry object. More...
 
void Unlock ()
 Implements C# lock() statement unlocking. Call directly or use LockContext sentry object. More...
 
virtual bool Equals (ptr obj)
 Compares objects using C# Object.Equals semantics. More...
 
virtual int32_t GetHashCode () const
 Analog of C# Object.GetHashCode() method. Enables hashing of custom objects. More...
 
virtual ptr MemberwiseClone () const
 Analog of C# Object.MemberwiseClone() method. Enables cloning custom types. More...
 
virtual const TypeInfoGetType () const
 Gets actual type of object. Analog of C# System.Object.GetType() call. More...
 
virtual bool Is (const TypeInfo &targetType) const
 Check if object represents an instance of type described by targetType. Analog of C# 'is' operator. More...
 
virtual void SetTemplateWeakPtr (uint32_t argument)
 Set n'th template argument a weak pointer (rather than shared). Allows switching pointers in containers to weak mode. More...
 
virtual bool FastCast (const Details::FastRttiBase &helper, void **out_ptr) const
 For internal purposes only. More...
 
template<>
bool ReferenceEquals (String const &str, std::nullptr_t)
 Specialization of Object::ReferenceEquals for case of string and nullptr. More...
 
template<>
bool ReferenceEquals (String const &str1, String const &str2)
 Specialization of Object::ReferenceEquals for case of strings. More...
 

Protected Member Functions

 Details_SocketException (const System::String &message)
 Constructs a new instance. More...
 
 Details_SocketException (int32_t errorCode)
 Constructs a new instance. More...
 
 Details_SocketException (SocketError socketError)
 Constructs a new instance. More...
 
 Details_SocketException ()
 Constructs a new instance. More...
 
void DoThrow (const ExceptionPtr &self) const override
 Throws exception instance wrapped by exception wrapper. More...
 
 Details_SocketException (std::nullptr_t)
 Constructs a new instance. More...
 
 Details_SocketException (const System::String &message, int32_t errorCode)
 Constructs a new instance. More...
 
- Protected Member Functions inherited from System::Details_Exception
 Details_Exception ()
 Constructs an instance of Exception class. More...
 
 Details_Exception (const String &message)
 Constructs an instance of Exception class and assigns the specified error message to it. More...
 
 Details_Exception (const String &message, const ExceptionWrapper< Details_Exception > &innerException)
 Constructs an instance of Exception class and assigns the specified error message and a reference to the inner exception object. More...
 
 Details_Exception (const System::SharedPtr< System::Runtime::Serialization::SerializationInfo > &info, System::Runtime::Serialization::StreamingContext context)
 Deserializes exception. More...
 
virtual String ExtraDescription () const
 Returns a string containing additional description of the exception. More...
 
String DefaultMessage () const
 Returns a default description of the exception based on type. More...
 

Additional Inherited Members

- Public Types inherited from System::Object
typedef SmartPtr< Objectptr
 Alias for smart pointer type. More...
 
- Static Public Member Functions inherited from System::Object
static bool ReferenceEquals (ptr const &objA, ptr const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, T const &objB)
 Compares objects by reference. More...
 
template<typename T >
static std::enable_if<!IsSmartPtr< T >::value, bool >::type ReferenceEquals (T const &objA, std::nullptr_t)
 Reference-compares value type object with nullptr. More...
 
template<typename T1 , typename T2 >
static std::enable_if< IsSmartPtr< T1 >::value &&IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares reference type objects in C# style. More...
 
template<typename T1 , typename T2 >
static std::enable_if<!IsSmartPtr< T1 >::value &&!IsSmartPtr< T2 >::value, bool >::type Equals (T1 const &objA, T2 const &objB)
 Compares value type objects in C# style. More...
 
static const TypeInfoType ()
 Implements C# typeof(System.Object) construct. More...
 
template<>
bool Equals (float const &objA, float const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
template<>
bool Equals (double const &objA, double const &objB)
 Emulates C#-style floating point comparison where two NaNs are considered equal even though according to IEC 60559:1989 NaN is not equal to any value, including NaN. More...
 
- Protected Attributes inherited from System::Details_Exception
String m_message
 The error description. More...
 
System::ExceptionWrapper< Details_Exceptionm_innerexception
 The Exception object representing the inner exception. More...
 
std::string m_std_message
 A string describing the std::exception portion of the current object. More...
 
int32_t m_HResult
 HRESULT code associated with the exception represented by the current object. More...
 

Detailed Description

Represents the exception thrown when a socket error occurs. Never create instances of this class manually. Use the SocketException class instead. Never wrap the SocketException class instances into System::SmartPtr.

Constructor & Destructor Documentation

◆ Details_SocketException() [1/6]

System::Net::Sockets::Details_SocketException::Details_SocketException ( const System::String message)
protected

Constructs a new instance.

Parameters
messageThe error description.

◆ Details_SocketException() [2/6]

System::Net::Sockets::Details_SocketException::Details_SocketException ( int32_t  errorCode)
protected

Constructs a new instance.

Parameters
errorCodeThe error code.

◆ Details_SocketException() [3/6]

System::Net::Sockets::Details_SocketException::Details_SocketException ( SocketError  socketError)
protected

Constructs a new instance.

Parameters
socketErrorThe socket error code.

◆ Details_SocketException() [4/6]

System::Net::Sockets::Details_SocketException::Details_SocketException ( )
protected

Constructs a new instance.

◆ Details_SocketException() [5/6]

System::Net::Sockets::Details_SocketException::Details_SocketException ( std::nullptr_t  )
protected

Constructs a new instance.

Remarks
Used to support the null pointer value.

◆ Details_SocketException() [6/6]

System::Net::Sockets::Details_SocketException::Details_SocketException ( const System::String message,
int32_t  errorCode 
)
protected

Constructs a new instance.

Parameters
messageThe error description.
errorCodeThe error code.

Member Function Documentation

◆ DoThrow()

void System::Net::Sockets::Details_SocketException::DoThrow ( const ExceptionPtr self) const
overrideprotectedvirtual

Throws exception instance wrapped by exception wrapper.

Parameters
selfException instance to be thrown.

Reimplemented from System::Details_Exception.

◆ get_ErrorCode()

int32_t System::Net::Sockets::Details_SocketException::get_ErrorCode ( )

Gets the error code.

Returns
The error code.

◆ get_SocketErrorCode()

SocketError System::Net::Sockets::Details_SocketException::get_SocketErrorCode ( )

Gets the socket error code.

Returns
The socket error code.

◆ set_ErrorCode()

void System::Net::Sockets::Details_SocketException::set_ErrorCode ( int32_t  code)

Sets the error code.

Parameters
codeThe error code to set.

◆ set_SocketErrorCode()

void System::Net::Sockets::Details_SocketException::set_SocketErrorCode ( SocketError  socketError)

Sets the socket error code.

Parameters
socketErrorThe socket error code to set.