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

// Copyright (c) 2005-2009 Nokia Corporation and/or its subsidiary(-ies).
// All rights reserved.
// This component and the accompanying materials are made available
// 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
// which accompanies this distribution, and is available
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
//
// Initial Contributors:
// Nokia Corporation - initial contribution.
//
// Contributors:
//
// Description:
//

#ifndef __OBEXTRANSPORTINFO_H__
#define __OBEXTRANSPORTINFO_H__

#include <e32std.h>

/**
This class is a combination of the TObexProtocolInfo and TObexProtocolPolicy 
classes.
This class is designed for licensee derivation, to support novel transport 
controllers. Existing superclasses include @c TObexUsbTransportInfo, @c 
TObexUsbV2TransportInfo, @c TObexBtTransportInfo and @c TObexIrTransportInfo. 
It is also designed for 3rd party instantiation, for use when creation a 
CObexServer or a CObexClient.

Note that, being a T-type, this type and all derived types must hold data by 
value, to support bitwise copying.

@publishedAll
@released
*/
class TObexTransportInfo
	{
public:
	/**
	The type of the transport over which obex will run.
	The size of the buffer is chosen for historical reasons. This is the size 
	originally used by TObexProtocolInfo.
	@publishedAll
	@released
	*/
	TBuf<60> iTransportName; 
	
	/**
	The version of the protocol policy format that this class supports
	@publishedAll
	@released
	*/
	TUint16 iVersion;
	
	/**
	The maximum size of the receive packet buffer for the policy
	@publishedAll
	@released
	*/
	TUint16 iReceiveMtu;
	
	/**
	The maximum size of the transmit packet buffer for the policy
	@publishedAll
	@released
	*/
	TUint16 iTransmitMtu;
	
	/**	*/
	TUint16 iFuture1;
	
	/**	*/
	TUint32 iFuture2;
	
	/**	*/
	TInt iFuture3;
	
	/**	*/
	TInt iFuture4;
	};

#endif // __OBEXTRANSPORTINFO_H__