Ice 3.7 C++11 API Reference
Public Member Functions | Static Public Member Functions | Public Attributes | List of all members
Ice::BadMagicException Class Reference

This exception indicates that a message did not start with the expected magic number ('I', 'c', 'e', 'P'). More...

#include <Ice/Ice.h>

Inheritance diagram for Ice::BadMagicException:
Inheritance graph
[legend]
Collaboration diagram for Ice::BadMagicException:
Collaboration graph
[legend]

Public Member Functions

 BadMagicException (const BadMagicException &)=default
 
 BadMagicException (const char *file, int line)
 The file and line number are required for all local exceptions. More...
 
 BadMagicException (const char *file, int line, const ::std::string &reason, const ByteSeq &badMagic)
 One-shot constructor to initialize all data members. More...
 
virtual void ice_print (::std::ostream &stream) const override
 Prints this exception to the given stream. More...
 
std::tuple< const ::std::string &, const ::Ice::ByteSeq & > ice_tuple () const
 Obtains a tuple containing all of the exception's data members. More...
 
virtual ~BadMagicException ()
 
- Public Member Functions inherited from Ice::LocalExceptionHelper< BadMagicException, ProtocolException >
virtual std::string ice_id () const override
 
- Public Member Functions inherited from IceUtil::ExceptionHelper< BadMagicException, ProtocolException >
std::unique_ptr< BadMagicException > ice_clone () const
 
virtual void ice_throw () const override
 Throws this exception. More...
 

Static Public Member Functions

static const ::std::string & ice_staticId ()
 Obtains the Slice type ID of this exception. More...
 

Public Attributes

::Ice::ByteSeq badMagic
 A sequence containing the first four bytes of the incorrect message. More...
 

Detailed Description

This exception indicates that a message did not start with the expected magic number ('I', 'c', 'e', 'P').

Constructor & Destructor Documentation

◆ ~BadMagicException()

virtual Ice::BadMagicException::~BadMagicException ( )
virtual

◆ BadMagicException() [1/3]

Ice::BadMagicException::BadMagicException ( const BadMagicException )
default

◆ BadMagicException() [2/3]

Ice::BadMagicException::BadMagicException ( const char *  file,
int  line 
)
inline

The file and line number are required for all local exceptions.

Parameters
fileThe file name in which the exception was raised, typically __FILE__.
lineThe line number at which the exception was raised, typically __LINE__.

◆ BadMagicException() [3/3]

Ice::BadMagicException::BadMagicException ( const char *  file,
int  line,
const ::std::string &  reason,
const ByteSeq badMagic 
)
inline

One-shot constructor to initialize all data members.

The file and line number are required for all local exceptions.

Parameters
fileThe file name in which the exception was raised, typically __FILE__.
lineThe line number at which the exception was raised, typically __LINE__.
reasonThe reason for the failure.
badMagicA sequence containing the first four bytes of the incorrect message.

Member Function Documentation

◆ ice_print()

virtual void Ice::BadMagicException::ice_print ( ::std::ostream &  stream) const
overridevirtual

Prints this exception to the given stream.

Parameters
streamThe target stream.

◆ ice_staticId()

static const ::std::string& Ice::BadMagicException::ice_staticId ( )
static

Obtains the Slice type ID of this exception.

Returns
The fully-scoped type ID.

◆ ice_tuple()

std::tuple<const ::std::string&, const ::Ice::ByteSeq&> Ice::BadMagicException::ice_tuple ( ) const
inline

Obtains a tuple containing all of the exception's data members.

Returns
The data members in a tuple.

Member Data Documentation

◆ badMagic

::Ice::ByteSeq Ice::BadMagicException::badMagic

A sequence containing the first four bytes of the incorrect message.


The documentation for this class was generated from the following file: