epoc32/include/obex/internal/obextransportconstants.h
branchSymbian2
changeset 2 2fe1408b6811
     1.1 --- /dev/null	Thu Jan 01 00:00:00 1970 +0000
     1.2 +++ b/epoc32/include/obex/internal/obextransportconstants.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -0,0 +1,74 @@
     1.4 +// Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
     1.5 +// All rights reserved.
     1.6 +// This component and the accompanying materials are made available
     1.7 +// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     1.8 +// which accompanies this distribution, and is available
     1.9 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.10 +//
    1.11 +// Initial Contributors:
    1.12 +// Nokia Corporation - initial contribution.
    1.13 +//
    1.14 +// Contributors:
    1.15 +//
    1.16 +// Description:
    1.17 +//
    1.18 +
    1.19 +#ifndef __OBEXTRANSPORTCONSTANTS_H__
    1.20 +#define __OBEXTRANSPORTCONSTANTS_H__
    1.21 +
    1.22 +/**
    1.23 +@file
    1.24 +@internalTechnology
    1.25 +*/
    1.26 +
    1.27 +#include <e32base.h>
    1.28 +
    1.29 +const TUint8 KObexConnectionIDLength = 4;
    1.30 +
    1.31 +typedef TUint16 TObexHeaderMask;
    1.32 +typedef TUint8 TObexOpcode;
    1.33 +typedef TBuf8<KObexConnectionIDLength> TConnId;
    1.34 +typedef TBuf8<16> TNonce;
    1.35 +typedef TBuf8<16> TRequestDigest;
    1.36 +
    1.37 +/**
    1.38 +This enum is for INTERNAL USE ONLY.
    1.39 +
    1.40 +The enum values are signals sent between layers in OBEX. Some of them result 
    1.41 +in user-visible notifications and some don't.
    1.42 +
    1.43 +Their numerical values are not significant, with the exception of the fact 
    1.44 +that EObexFinalPacketStarted must have a lower numerical value than 
    1.45 +EObexFinalPacketFinished. If both of these signals are outstanding on a packet 
    1.46 +at once, the user will be notified in numerical-value order. The 'final packet 
    1.47 +observer' API requires that the signals are given to the user in the order 
    1.48 +'final packet started' then 'final packet finished'. 
    1.49 +
    1.50 +These are to be used as fields in a bitmask, so a value must always bit set.
    1.51 +*/
    1.52 +enum TObexPacketProcessEvent
    1.53 +	{
    1.54 +	/** The transport layer has started to write a final packet. */
    1.55 +	EObexFinalPacketStarted = 0x1,
    1.56 +
    1.57 +	/** The transport layer has finished writing a final packet. */
    1.58 +	EObexFinalPacketFinished = 0x2,
    1.59 +
    1.60 +	/** A packet has finished being written. */
    1.61 +	EObexWriteCompleted = 0x4,
    1.62 +	
    1.63 +	/** A packet has finished being written. This is signalled upwards by the 
    1.64 +	transport layer last of all	because it signals the completion of the 
    1.65 +	sending of an ACK to a disconnect command. The OBEX server uses this 
    1.66 +	signal to progress the disconnection. */
    1.67 +	EObexWriteCompletedFinal = 0x8,
    1.68 +	
    1.69 +	/** Read activity has been detected. This is signalled upwards by the 
    1.70 +	transport layer AT LEAST when the first read of a new Obex operation 
    1.71 +	is detected.	*/
    1.72 +	EObexReadActivityDetected = 0x10,
    1.73 +	};
    1.74 +
    1.75 +typedef TUint TObexPacketProcessEvents;
    1.76 +
    1.77 +#endif //__OBEXTRANSPORTCONSTANTS_H