WOscException.h File Reference

#include "WOscLib.h"
#include <string>

Go to the source code of this file.

Enumerations
enum	ErrorCodes {   ERR_NO_ERROR = 0, ERR_REMOVE_FROM_EMPTY_QUEUE, ERR_INVALID_ADDRESS_NO_SLASH, ERR_NOT_DISPATCHING_FROM_ROOT,   ERR_PARENT_POINTER_NULL, ERR_ROOT_ALIAS, ERR_NULL_ADDRESS, ERR_OSC_STR_BUFF_TOO_SMALL,   ERR_NULL_BUFFER, ERR_INVALID_INDEX, ERR_BUFFER_TO_SMALL, ERR_NOT_ROOT_CONTAINER,   ERR_RECURSIVE_ALIAS, ERR_TOO_SHORT, ERR_EMPTY_BUNDLE, ERR_INVALID_TAG,   ERR_CURRUPT_BUNDLE_LAYOUT, ERR_NO_ITEMS_IN_BUNDLE, ERR_CAN_NOT_CLONE_UNINITIALIZED_BUNDLE }

---

Detailed Description

WOscException header file.

Author

cls-nebadje

( ucf )

Date

2009-01-13 17:23:19

Revision

1.4

Copyright (c) Weiss Engineering Ltd

Definition in file WOscException.h.

---

Enumeration Type Documentation

enum ErrorCodes

The error codes of all exceptions which are thrown inside the Weiss OSC Library. Refer to these defines when handling exceptions. Enumeration values: ERR_NO_ERROR  No exception occurred (should not happen when throwing exceptions). ERR_REMOVE_FROM_EMPTY_QUEUE  Trying to remove items from an empty priority queue. See also: WOscPriorityQueue. ERR_INVALID_ADDRESS_NO_SLASH  Trying to initialize a WOscMessage with a corrupt address with missing slash at the beginning. ERR_NOT_DISPATCHING_FROM_ROOT  Messages can only be dispatched beginning at a root container. See also: WOscContainer ERR_PARENT_POINTER_NULL  During construction of a WOscContainer or WOscMethod a NULL pointer was passed as parent or someone tried to add an OSC container alias (or an OSC method/method-alias) with NULL pointer as parent. See also: WOscContainer. ERR_NULL_ADDRESS  NULL-pointer argument passed to constructor of WOscMessage. See also: WOscMessage::WOscMessage(const char *address) ERR_OSC_STR_BUFF_TOO_SMALL  When using the getBuffer(char* buffer, int bufferLen) functions (included in several classes) and the passed buffer of length "bufferLen" is smaller than the object-internal data-length, this exception will be raised. See also: WOscMessage | WOscBundle | WOscString ERR_NULL_BUFFER  When passed a null pointer to the constructor of an OSC-message when constructing from a byte-stream. See also: WOscMessage::WOscMessage(char* buffer, int bufferLen) ERR_INVALID_INDEX  When extracting bundle elements (messages or bundles) from a WOscBundle object or arguments from a WOscMessage object, make sure the "idx" parameter remains in valid boundaries by getting the number of elements contained in the bundle. See also: WOscMessage WOscBundle::GetMessage(int idx) | WOscBundle WOscBundle::GetBundle(int idx). | WOscBundle::GetNumMessages() | WOscBundle::GetNumBundles() WOscMessage::getFloat(int idx) | WOscMessage::getInt(int idx) | WOscMessage::getString(int idx) | WOscMessage::getBlob(int idx) ERR_BUFFER_TO_SMALL  When using the getBuffer(char* buffer, int bufferLen) functions (included in several classes) and the passed buffer of length "bufferLen" is smaller than the object-internal data-length, this exception will be raised. See also: WOscBundle | WOscBundle::getBuffer(char* buffer, int bufferLen) ERR_NOT_ROOT_CONTAINER  Trying to set a not-root-conatiner as address-space. See also: WOscReceiver::setAddressSpace(WOscContainer* addrSpaceRootContainer) ERR_RECURSIVE_ALIAS  Todo: Definition at line 48 of file WOscException.h. { ERR_NO_ERROR = 0, /**< No exception occurred (should not happen * when throwing exceptions). */ ERR_REMOVE_FROM_EMPTY_QUEUE, /**< Trying to remove items from an empty * priority queue. \see WOscPriorityQueue. */ ERR_INVALID_ADDRESS_NO_SLASH, /**< Trying to initialize a WOscMessage with * a corrupt address with missing slash at the * beginning. */ ERR_NOT_DISPATCHING_FROM_ROOT, /**< Messages can only be dispatched beginning * at a root container. * \see WOscContainer */ ERR_PARENT_POINTER_NULL, /**< During construction of a WOscContainer or WOscMethod a NULL pointer was passed * as parent or someone tried to add an OSC container alias (or an * OSC method/method-alias) with NULL pointer as parent. * \see WOscContainer. */ ERR_ROOT_ALIAS, /** The root container can not be added as alias to any container. * */ ERR_NULL_ADDRESS, /**< NULL-pointer argument passed to constructor * of WOscMessage. * \see WOscMessage::WOscMessage(const char *address) */ ERR_OSC_STR_BUFF_TOO_SMALL, /**< When using the getBuffer(char* buffer, int bufferLen) * functions (included in several classes) and the * passed buffer of length "bufferLen" is smaller than * the object-internal data-length, this exception will be * raised. * \see WOscMessage | WOscBundle | WOscString */ ERR_NULL_BUFFER, /**< When passed a null pointer to the constructor * of an OSC-message when constructing from a byte-stream. * \see WOscMessage::WOscMessage(char* buffer, int bufferLen) */ ERR_INVALID_INDEX, /**< When extracting bundle elements (messages or bundles) from * a WOscBundle object or arguments from a WOscMessage object, * make sure the "idx" parameter remains in valid boundaries by * getting the number of elements contained in the bundle. * \see WOscMessage WOscBundle::GetMessage(int idx) | * WOscBundle WOscBundle::GetBundle(int idx). | * WOscBundle::GetNumMessages() | WOscBundle::GetNumBundles() * WOscMessage::getFloat(int idx) | WOscMessage::getInt(int idx) | * WOscMessage::getString(int idx) | WOscMessage::getBlob(int idx) */ ERR_BUFFER_TO_SMALL, /**< When using the getBuffer(char* buffer, int bufferLen) * functions (included in several classes) and the * passed buffer of length "bufferLen" is smaller than * the object-internal data-length, this exception will be * raised. * \see WOscBundle | WOscBundle::getBuffer(char* buffer, int bufferLen) */ ERR_NOT_ROOT_CONTAINER, /**< Trying to set a not-root-conatiner as address-space. * \see WOscReceiver::setAddressSpace(WOscContainer* addrSpaceRootContainer) */ ERR_RECURSIVE_ALIAS, /**<\todo */ ERR_TOO_SHORT, ERR_EMPTY_BUNDLE, ERR_INVALID_TAG, ERR_CURRUPT_BUNDLE_LAYOUT, ERR_NO_ITEMS_IN_BUNDLE, ERR_CAN_NOT_CLONE_UNINITIALIZED_BUNDLE, };

---