epoc32/include/mw/obexirtransportinfo.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 3 e1b950c65cb4
permissions -rw-r--r--
Current Symbian^3 public API header files (from PDK 3.0.h)
This is the epoc32/include tree with the "platform" subtrees removed, and
all but a selected few mbg and rsg files removed.
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@4
     4
// under the terms of "Eclipse Public License v1.0"
williamr@2
     5
// which accompanies this distribution, and is available
williamr@4
     6
// at the URL "http://www.eclipse.org/legal/epl-v10.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 __OBEXIRTRANSPORTINFO_H__
williamr@2
    17
#define __OBEXIRTRANSPORTINFO_H__
williamr@2
    18
williamr@2
    19
#include <ir_sock.h>
williamr@2
    20
#include <obextransportinfo.h>
williamr@2
    21
williamr@2
    22
/**
williamr@2
    23
Concrete transport info type for use when using Irda ttp  transport controller.
williamr@2
    24
@see KObexIrTTPProtocol
williamr@2
    25
@publishedAll
williamr@2
    26
@released
williamr@2
    27
*/
williamr@2
    28
NONSHARABLE_CLASS(TObexIrTransportInfo) : public TObexTransportInfo
williamr@2
    29
williamr@2
    30
	{
williamr@2
    31
//From TObexIrProtocolInfo
williamr@2
    32
public:
williamr@2
    33
	/** IrDA address information for this connection, as used in the IrDA sockets interface.
williamr@2
    34
	Refer to the SDK for more information about this.
williamr@2
    35
	Its main use is for setting the port that the local machine will listen on. */
williamr@2
    36
	TIrdaSockAddr iAddr;
williamr@2
    37
	/** The IAS class value that the OBEX session will register its listener port,
williamr@2
    38
	or request remote port with. */
williamr@2
    39
	TBuf8<KIASClassNameMax> iClassName;
williamr@2
    40
	/** The IAS attribute value that the OBEX session will register its listener port,
williamr@2
    41
	or request remote port with. */
williamr@2
    42
	TBuf8<KIASAttributeNameMax> iAttributeName;
williamr@2
    43
	};
williamr@2
    44
williamr@2
    45
/**
williamr@2
    46
Concrete transport info type for use when using Irda ttp  transport controller, with discovery extensions.
williamr@2
    47
@see KObexIrTTPProtocolV2
williamr@2
    48
@publishedAll
williamr@2
    49
@released
williamr@2
    50
*/
williamr@2
    51
NONSHARABLE_CLASS(TObexIrV2TransportInfo) : public TObexIrTransportInfo
williamr@2
    52
williamr@2
    53
	{
williamr@2
    54
//From TObexIrProtocolInfo
williamr@2
    55
public:
williamr@2
    56
	/** The number of discovery slots to use. */
williamr@2
    57
	TUint8 iDiscoverySlots;
williamr@2
    58
	/** The number of discovery attempts to make. */
williamr@2
    59
	TUint8 iDiscoveryAttempts;
williamr@2
    60
	
williamr@2
    61
private:
williamr@2
    62
	// This data padding has been added to help prevent future binary compatibility breaks	
williamr@2
    63
	// None of these padding variables have been zero'd because they are currently not used
williamr@2
    64
	TUint32     iPadding1; 
williamr@2
    65
	TUint32     iPadding2; 		
williamr@2
    66
	TUint32     iPadding3; 
williamr@2
    67
	TUint32     iPadding4; 	
williamr@2
    68
	};
williamr@2
    69
williamr@2
    70
williamr@2
    71
/**
williamr@2
    72
Concrete transport info type for use when using Irda ttp transport controller, with nickname extension.
williamr@2
    73
@see KObexIrTTPProtocolV3
williamr@2
    74
@publishedAll
williamr@2
    75
williamr@2
    76
@capability WriteDeviceData If the TObexIrV3TransportInfo is passed as the argument
williamr@2
    77
                            to CObexServer::NewL or CObexClient::NewL and the associated 
williamr@2
    78
                            name is valid.
williamr@2
    79
williamr@2
    80
@released
williamr@2
    81
*/
williamr@2
    82
NONSHARABLE_CLASS(TObexIrV3TransportInfo) : public TObexIrV2TransportInfo
williamr@2
    83
	{
williamr@2
    84
public:
williamr@2
    85
	/** The device nickname.  The maximum length in the IrDA specification
williamr@2
    86
	is defined as 23 - (number of hint octets [2] + 1)  =  20
williamr@2
    87
	*/
williamr@2
    88
	TBuf<20> iLocalDeviceNickname;
williamr@2
    89
	
williamr@2
    90
	/** A flag indicating if the device nickname field is valid.  This
williamr@2
    91
	allows Symbian to make further derivations of this interface without making
williamr@2
    92
	the device nickname mandatory */
williamr@2
    93
	TBool iLocalDeviceNicknameValid;
williamr@2
    94
	};
williamr@2
    95
williamr@2
    96
#endif // __OBEXIRTRANSPORTINFO_H__