epoc32/include/obex/internal/obextransportconstants.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
permissions -rw-r--r--
Final list of Symbian^2 public API header files
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@2
     4
// 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
williamr@2
     5
// which accompanies this distribution, and is available
williamr@2
     6
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.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 __OBEXTRANSPORTCONSTANTS_H__
williamr@2
    17
#define __OBEXTRANSPORTCONSTANTS_H__
williamr@2
    18
williamr@2
    19
/**
williamr@2
    20
@file
williamr@2
    21
@internalTechnology
williamr@2
    22
*/
williamr@2
    23
williamr@2
    24
#include <e32base.h>
williamr@2
    25
williamr@2
    26
const TUint8 KObexConnectionIDLength = 4;
williamr@2
    27
williamr@2
    28
typedef TUint16 TObexHeaderMask;
williamr@2
    29
typedef TUint8 TObexOpcode;
williamr@2
    30
typedef TBuf8<KObexConnectionIDLength> TConnId;
williamr@2
    31
typedef TBuf8<16> TNonce;
williamr@2
    32
typedef TBuf8<16> TRequestDigest;
williamr@2
    33
williamr@2
    34
/**
williamr@2
    35
This enum is for INTERNAL USE ONLY.
williamr@2
    36
williamr@2
    37
The enum values are signals sent between layers in OBEX. Some of them result 
williamr@2
    38
in user-visible notifications and some don't.
williamr@2
    39
williamr@2
    40
Their numerical values are not significant, with the exception of the fact 
williamr@2
    41
that EObexFinalPacketStarted must have a lower numerical value than 
williamr@2
    42
EObexFinalPacketFinished. If both of these signals are outstanding on a packet 
williamr@2
    43
at once, the user will be notified in numerical-value order. The 'final packet 
williamr@2
    44
observer' API requires that the signals are given to the user in the order 
williamr@2
    45
'final packet started' then 'final packet finished'. 
williamr@2
    46
williamr@2
    47
These are to be used as fields in a bitmask, so a value must always bit set.
williamr@2
    48
*/
williamr@2
    49
enum TObexPacketProcessEvent
williamr@2
    50
	{
williamr@2
    51
	/** The transport layer has started to write a final packet. */
williamr@2
    52
	EObexFinalPacketStarted = 0x1,
williamr@2
    53
williamr@2
    54
	/** The transport layer has finished writing a final packet. */
williamr@2
    55
	EObexFinalPacketFinished = 0x2,
williamr@2
    56
williamr@2
    57
	/** A packet has finished being written. */
williamr@2
    58
	EObexWriteCompleted = 0x4,
williamr@2
    59
	
williamr@2
    60
	/** A packet has finished being written. This is signalled upwards by the 
williamr@2
    61
	transport layer last of all	because it signals the completion of the 
williamr@2
    62
	sending of an ACK to a disconnect command. The OBEX server uses this 
williamr@2
    63
	signal to progress the disconnection. */
williamr@2
    64
	EObexWriteCompletedFinal = 0x8,
williamr@2
    65
	
williamr@2
    66
	/** Read activity has been detected. This is signalled upwards by the 
williamr@2
    67
	transport layer AT LEAST when the first read of a new Obex operation 
williamr@2
    68
	is detected.	*/
williamr@2
    69
	EObexReadActivityDetected = 0x10,
williamr@2
    70
	};
williamr@2
    71
williamr@2
    72
typedef TUint TObexPacketProcessEvents;
williamr@2
    73
williamr@2
    74
#endif //__OBEXTRANSPORTCONSTANTS_H