epoc32/include/mw/obexpanics.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
williamr@2
     1
// Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@4
     4
// under the terms of "Eclipse Public License v1.0"
williamr@2
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
//
williamr@2
    15
williamr@2
    16
#ifndef OBEX_PANICS_H
williamr@2
    17
#define OBEX_PANICS_H
williamr@2
    18
williamr@2
    19
/**
williamr@2
    20
@file
williamr@2
    21
@publishedAll
williamr@2
    22
@released
williamr@2
    23
williamr@2
    24
This file contains details of all OBEX and OBEX Transport panics which may be raised
williamr@2
    25
as a result programming error by the users of OBEX (e.g. Client or Server Application
williamr@2
    26
or a proprietry transport controller).
williamr@2
    27
williamr@2
    28
Internal panic codes should not be raised due to user errors but would reflect
williamr@2
    29
internal Obex programming errors - see inc/obexfaults.h
williamr@2
    30
*/
williamr@2
    31
williamr@2
    32
williamr@2
    33
/**
williamr@2
    34
Category for Obex panics
williamr@2
    35
@see TObexPanicCode
williamr@2
    36
*/
williamr@2
    37
_LIT(KObexPanicCategory, "Obex");
williamr@2
    38
williamr@2
    39
/**
williamr@2
    40
@publishedAll
williamr@2
    41
@released
williamr@2
    42
williamr@2
    43
All Obex panics which may be raised as a result of a client (i.e. external) programming error.
williamr@2
    44
Internal Obex panics are errors listed in TObexFaultCode
williamr@2
    45
@see TObexFaultCode
williamr@2
    46
*/
williamr@2
    47
enum TObexPanicCode
williamr@2
    48
	{
williamr@2
    49
	/** A NULL value was supplied for the data buffer.  Note that this
williamr@2
    50
	pointer can refer to either a memory buffer or a pointer to a RFile object.
williamr@2
    51
 	@see CObexBufObject
williamr@2
    52
 	*/
williamr@2
    53
	ENullPointer					= 0,
williamr@2
    54
	
williamr@2
    55
	
williamr@2
    56
	/** The supplied buffer is of zero length.
williamr@2
    57
	@see CObexBufObject
williamr@2
    58
	*/
williamr@2
    59
	EEmptyBuffer					= 1,
williamr@2
    60
	
williamr@2
    61
	
williamr@2
    62
	/** The header is not of the requested type.
williamr@2
    63
	@see CObexHeader
williamr@2
    64
	*/
williamr@2
    65
	EHeaderAsBadType				= 2,
williamr@2
    66
	
williamr@2
    67
	
williamr@2
    68
	/** An unknown TFileBuffering value was supplied.
williamr@2
    69
 	@see CObexBufObject
williamr@2
    70
 	*/
williamr@2
    71
	EInvalidBufferStrategy			= 3,
williamr@2
    72
	
williamr@2
    73
	
williamr@2
    74
 	/** The RFile object does not point to a valid (open) file.
williamr@2
    75
 	@see CObexBufObject
williamr@2
    76
 	*/
williamr@2
    77
 	ENullFileHandle					= 4,
williamr@2
    78
 	
williamr@2
    79
 	
williamr@2
    80
 	/** An unknown TObexBufferingDetails object was supplied to a buffer object.
williamr@2
    81
 	@see CObexBufObject
williamr@2
    82
 	*/
williamr@2
    83
 	EInvalidBufferDetails			= 5,
williamr@2
    84
 	
williamr@2
    85
 	
williamr@2
    86
	/** A call has been made to CObexServer::RequestIndicationCallback when no
williamr@2
    87
	asynchronous request is outstanding.
williamr@2
    88
	@see MObexNotifyAsync
williamr@2
    89
	@see CObexServer
williamr@2
    90
	*/
williamr@2
    91
	ENoNotificationToComplete		= 6,
williamr@2
    92
williamr@2
    93
williamr@2
    94
	/** A call has been made to CObexServer::Start when an asynchronous request
williamr@2
    95
	is outstanding.
williamr@2
    96
	@see MObexNotifyAsync
williamr@2
    97
	@see CObexServer
williamr@2
    98
	*/
williamr@2
    99
	EChangeInterfaceDuringWait		= 7,
williamr@2
   100
williamr@2
   101
williamr@2
   102
williamr@2
   103
 	/** An invalid packet process event has been signalled.
williamr@2
   104
	*/
williamr@2
   105
	EBadPacketProcessEvent			= 8,
williamr@2
   106
williamr@2
   107
williamr@2
   108
	/** An event is available for signalling, but there is no observer set.
williamr@2
   109
	*/
williamr@2
   110
	ENoPacketProcessObserverSet		= 9,
williamr@2
   111
	
williamr@2
   112
	/** In CObexServer, a call has been made to RequestCompleteIndicationCallback(TObexResponse)
williamr@2
   113
	or RequestIndicationCallback(TObexResponse) with invalid response code or 
williamr@2
   114
    RequestCompleteIndicationCallback(TInt) with invalid Symbian error code
williamr@2
   115
	*/
williamr@2
   116
	EInvalidResponseCodeFromServerApp = 10,
williamr@2
   117
	
williamr@2
   118
	/** In CObexServer, RequestCompleteIndicationCallback has been called in response to Put/GetRequestIndication
williamr@2
   119
	or ReuqestIndicationCallback has been called in response to Put/GetComplete or SetPath Indication
williamr@2
   120
	*/
williamr@2
   121
	EInvalidResponseCallback = 11,
williamr@2
   122
williamr@2
   123
	/** The last server response code has been requested prior to a response from the server.
williamr@2
   124
	*/
williamr@2
   125
	ENoResponseCodeToReturn			= 12,
williamr@2
   126
williamr@2
   127
	/** Adding End of Body header when there is data in the object. 
williamr@2
   128
	*/
williamr@2
   129
	EAddingInvalidEoBHeader = 13,
williamr@2
   130
	
williamr@2
   131
	/** A user has requested to override the handling of a request
williamr@2
   132
	packet at an invalid time.
williamr@2
   133
	*/
williamr@2
   134
	EOverrideRequestHandlingInBadState = 14,
williamr@4
   135
	
williamr@4
   136
	/** A pointer must be null before constructing the object it points to.
williamr@4
   137
	*/
williamr@4
   138
	ENotNullPointer = 15,
williamr@2
   139
	};
williamr@2
   140
williamr@2
   141
williamr@2
   142
williamr@2
   143
/** 
williamr@2
   144
The category for obex transport panics
williamr@2
   145
*/
williamr@2
   146
_LIT(KObexTransportPanicCat, "ObexTransPanics");
williamr@2
   147
williamr@2
   148
/**
williamr@2
   149
Obex transport panics raised as a result of client programming error
williamr@2
   150
*/
williamr@2
   151
enum TObexTransportPanicCode
williamr@2
   152
	{
williamr@2
   153
	/**
williamr@2
   154
	The number of transport implementations for a given transport name is more than what is allowed.  
williamr@2
   155
	Check that there is not more than the allowed number of plugin resource files containing the same default
williamr@2
   156
	data and inteface uid.
williamr@2
   157
	*/
williamr@2
   158
 	EInvalidNumberOfTransportImplementations	= 0,	
williamr@2
   159
	};
williamr@2
   160
williamr@2
   161
#endif
williamr@4
   162