epoc32/include/obextransportinfo.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
parent 0 061f57f2323e
permissions -rw-r--r--
Final list of Symbian^2 public API header files
     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 the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     5 // which accompanies this distribution, and is available
     6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     7 //
     8 // Initial Contributors:
     9 // Nokia Corporation - initial contribution.
    10 //
    11 // Contributors:
    12 //
    13 // Description:
    14 //
    15 
    16 #ifndef __OBEXTRANSPORTINFO_H__
    17 #define __OBEXTRANSPORTINFO_H__
    18 
    19 #include <e32std.h>
    20 
    21 /**
    22 This class is a combination of the TObexProtocolInfo and TObexProtocolPolicy 
    23 classes.
    24 This class is designed for licensee derivation, to support novel transport 
    25 controllers. Existing superclasses include @c TObexUsbTransportInfo, @c 
    26 TObexUsbV2TransportInfo, @c TObexBtTransportInfo and @c TObexIrTransportInfo. 
    27 It is also designed for 3rd party instantiation, for use when creation a 
    28 CObexServer or a CObexClient.
    29 
    30 Note that, being a T-type, this type and all derived types must hold data by 
    31 value, to support bitwise copying.
    32 
    33 @publishedAll
    34 @released
    35 */
    36 class TObexTransportInfo
    37 	{
    38 public:
    39 	/**
    40 	The type of the transport over which obex will run.
    41 	The size of the buffer is chosen for historical reasons. This is the size 
    42 	originally used by TObexProtocolInfo.
    43 	@publishedAll
    44 	@released
    45 	*/
    46 	TBuf<60> iTransportName; 
    47 	
    48 	/**
    49 	The version of the protocol policy format that this class supports
    50 	@publishedAll
    51 	@released
    52 	*/
    53 	TUint16 iVersion;
    54 	
    55 	/**
    56 	The maximum size of the receive packet buffer for the policy
    57 	@publishedAll
    58 	@released
    59 	*/
    60 	TUint16 iReceiveMtu;
    61 	
    62 	/**
    63 	The maximum size of the transmit packet buffer for the policy
    64 	@publishedAll
    65 	@released
    66 	*/
    67 	TUint16 iTransmitMtu;
    68 	
    69 	/**	*/
    70 	TUint16 iFuture1;
    71 	
    72 	/**	*/
    73 	TUint32 iFuture2;
    74 	
    75 	/**	*/
    76 	TInt iFuture3;
    77 	
    78 	/**	*/
    79 	TInt iFuture4;
    80 	};
    81 
    82 #endif // __OBEXTRANSPORTINFO_H__