obex/obexprotocol/obex/inc/obexfaults.h
changeset 57 f6055a57ae18
parent 0 d0791faffa3f
equal deleted inserted replaced
54:4dc88a4ac6f4 57:f6055a57ae18
       
     1 // Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
       
     2 // All rights reserved.
       
     3 // This component and the accompanying materials are made available
       
     4 // under the terms of "Eclipse Public License v1.0"
       
     5 // which accompanies this distribution, and is available
       
     6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
       
     7 //
       
     8 // Initial Contributors:
       
     9 // Nokia Corporation - initial contribution.
       
    10 //
       
    11 // Contributors:
       
    12 //
       
    13 // Description:
       
    14 //
       
    15 
       
    16 #ifndef OBEX_FAULTS_H
       
    17 #define OBEX_FAULTS_H
       
    18 
       
    19 /**
       
    20 @file
       
    21 @internalComponent
       
    22 
       
    23 This file contains details of all Obex panics which may be raised as a result
       
    24 of an internal programming error.
       
    25 */
       
    26 
       
    27 
       
    28 /**
       
    29 Category for Obex faults
       
    30 */
       
    31 _LIT(KObexFaultCategory, "ObexFault");
       
    32 
       
    33 
       
    34 /**
       
    35 Obex fault codes
       
    36 */
       
    37 enum TObexFaultCode
       
    38 	{
       
    39 	/** USB has entered an unknown state.  This probably means TUsbcDeviceState
       
    40 	has changed without Obex being updated accordingly.
       
    41 	@see TUsbcDeviceState
       
    42 	@see CObexUsbHandler
       
    43 	*/
       
    44 	EUnknownUsbState				= 0,
       
    45 	
       
    46 	
       
    47 	/** The object still has references to it on destruction.
       
    48 	@see CRefCounted
       
    49 	*/
       
    50 	ERefCountNonZero				= 1,
       
    51 	
       
    52 	
       
    53 	/** An attempt has been made to construct an unknown buffering details
       
    54 	object.
       
    55 	@see TObexBufferingDetails
       
    56 	*/
       
    57  	EBadBufferDetailsVersion		= 2,
       
    58  	
       
    59  	
       
    60 	/** No receive packet is available to return.
       
    61 	@see CObexServerStateMachine
       
    62 	*/
       
    63 	ENoReceivePacketAvailable		= 3,
       
    64 	
       
    65 	
       
    66 	/** No notifier has been set to notify of an event.
       
    67 	Server should not be started without a notifier, so event handling is
       
    68 	not expected to occur.
       
    69 	@see CObexServerStateMachine
       
    70 	*/
       
    71 	ENoNotifierAvailable			= 4,
       
    72 	
       
    73 	
       
    74 	/** Synchronous state wrapper has been errored when calling
       
    75 	CObexServer::RequestIndicationCallback().
       
    76 	@see CObexServerSyncWrapper
       
    77 	*/
       
    78 	ESyncWrapperCallbackError		= 5,
       
    79 
       
    80 
       
    81 	/** An unexpected event has been sent to the state machine
       
    82 	@see CObexServer
       
    83 	@see CObexServerStateMachine
       
    84 	*/
       
    85 	EServerStateMachineBadEvent		= 6,
       
    86 
       
    87 	/** CreateTransportInfoL has been given an unrecognised 
       
    88 	TObexProtocolInfo::iTransport, and has therefore been unable to create a 
       
    89 	TObexTransportInfo.
       
    90 	@see IrOBEXUtil
       
    91 	*/
       
    92 	EUtilNoTransportInfo			= 7,
       
    93 
       
    94 	/** CObex::TransportDown() has been called
       
    95 	This is a legacy function that is retained for backwards compatibility.
       
    96 	It does not do anything and should not be called
       
    97 	@see CObex::TransportDown()
       
    98 	*/
       
    99 	ETransportDownCalled			= 8,
       
   100 
       
   101 	/** RespondAndEndOperation has been called, but the authentication
       
   102 	state machine does not think there is an OBEX connection
       
   103 	@see TObexServerOperationState::RespondAndEndOperation
       
   104 	*/
       
   105 	ERespondAndEndOpWithoutObexConnection	= 9,
       
   106 
       
   107 	/** CObexClient::ClientCommandL() does not recognise the operation
       
   108 	code value it is supplied.
       
   109 	@see CObexClient::ClientCommandL()
       
   110 	*/
       
   111 	EClientCommandOpUnrecognised		= 10,
       
   112 
       
   113 	/** CObexErrorEngine::LastError() does not recognise the error set
       
   114 	argument it is supplied.
       
   115 	@see CObexErrorEngine::LastError()
       
   116 	*/
       
   117 	EErrorSetUnrecognised			= 11,
       
   118 
       
   119 	/** CObexErrorEngine::LastError() does not recognise the underlying
       
   120 	error value that has been set.
       
   121 	@see CObexErrorEngine::LastError()
       
   122 	*/
       
   123 	EUnderlyingErrorUnrecognised		= 12,
       
   124 
       
   125 	/** The last underlying error is set twice during the lifetime
       
   126 	of a client operation.
       
   127 	@see CObexClient
       
   128 	*/
       
   129 	ELastErrorSetTwice			= 13,
       
   130 
       
   131 	/** The last underlying error was not set during the lifetime
       
   132 	of a client operation.
       
   133 	@see CObexClient
       
   134 	*/
       
   135 	ELastErrorNotSet			= 14,
       
   136 	
       
   137 	/** OnPacketReceive has been called but the state machine does not
       
   138 	believe the server to have been started.
       
   139 	@see CObexServerStateMachine::OnPacketReceive
       
   140 	*/
       
   141 	EPacketReceivedWhenServerNotStarted = 15,
       
   142 	
       
   143 	/** ConnectionComplete has been called but the state machine does
       
   144 	not believe the server to have been started.
       
   145 	@see CObexServerStateMachine::ConnectionComplete
       
   146 	*/
       
   147 	EConnectionCompleteWhenServerStopped = 16,
       
   148 	
       
   149 	/** Put received in bad state.  Note that all states where a put
       
   150 	is expected to be possible (even if due to invalid remote 
       
   151 	behaviour) override the base implementation.
       
   152 	@see TObexServerOperationState::Put
       
   153 	*/
       
   154 	EPutInBadState = 17,
       
   155 	
       
   156 	/** Get received in bad state.  Note that all states where a get
       
   157 	is expected to be possible (even if due to invalid remote 
       
   158 	behaviour) override the base implementation.
       
   159 	@see TObexServerOperationState::Get
       
   160 	*/
       
   161 	EGetInBadState = 18,
       
   162 	
       
   163 	/** SetPath received in bad state.  Note that all states where a 
       
   164 	setpath is expected to be possible (even if due to invalid remote 
       
   165 	behaviour) override the base implementation.
       
   166 	@see TObexServerOperationState::SetPath
       
   167 	*/
       
   168 	ESetPathInBadState = 19,
       
   169 	
       
   170 	/** Abort received in bad state.  Note that all states where an
       
   171 	abort is expected to be possible (even if due to invalid remote 
       
   172 	behaviour) override the base implementation.
       
   173 	@see TObexServerOperationState::Abort
       
   174 	*/
       
   175 	EAbortInBadState = 20,
       
   176 	
       
   177 	/** ConnectionComplete received in bad state.  Note that all states where
       
   178 	this is expected to be possible (even if due to invalid remote 
       
   179 	behaviour) override the base implementation.
       
   180 	@see TObexServerOperationState::ConnectionComplete
       
   181 	*/
       
   182 	EConnectionCompleteInBadState = 21,
       
   183 	
       
   184 	/** TransportUp received in bad state.  Note that all states where
       
   185 	this is expected to be possible override the base implementation.
       
   186 	@see TObexServerOperationState::TransportUp
       
   187 	*/
       
   188 	ETransportUpInBadState = 22,
       
   189 	
       
   190 	/** Connect received in bad state.  Note that all states where
       
   191 	this is expected to be possible override the base implementation.
       
   192 	@see TObexServerOperationState::Connect
       
   193 	*/
       
   194 	EConnectInBadState = 23,
       
   195 	
       
   196 	/** Disconnect received in bad state.  Note that all states where
       
   197 	this is expected to be possible override the base implementation.
       
   198 	@see TObexServerOperationState::Disconnect
       
   199 	*/
       
   200 	EDisconnectInBadState = 24,
       
   201 
       
   202 	/** In the current implementation, the transport controller should be 
       
   203 	created at CObex::ConstructL time and persist until ~CObex.
       
   204 	*/
       
   205 	ETransportControllerNotCreated = 25,
       
   206 	};
       
   207 
       
   208 #endif