epoc32/include/es_wsms.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:33:34 +0100
branchSymbian3
changeset 4 837f303aceeb
parent 2 2fe1408b6811
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) 1997-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
/**
williamr@2
    17
 @file
williamr@4
    18
 @publishedAll
williamr@2
    19
*/
williamr@2
    20
williamr@2
    21
#if !defined(__ES_WSMS_H__)
williamr@2
    22
#define __ES_WSMS_H__
williamr@2
    23
williamr@2
    24
#include <es_sock.h>
williamr@2
    25
williamr@2
    26
/** WAP SMS Protocol Module address family ID. */
williamr@2
    27
const TUint KWAPSMSAddrFamily=0x011;
williamr@2
    28
/** WAP SMS Protocol Module datagram protocol ID. */
williamr@2
    29
const TUint KWAPSMSDatagramProtocol=0x01;
williamr@2
    30
/** WAP SMS Protocol Module maximum number of sockets supported. */
williamr@2
    31
const TInt  KWAPSMSNumberSockets=0x100;
williamr@2
    32
/** The maximum datagram size the SMS sockets protocol supports. */
williamr@2
    33
const TUint KWAPSMSMaxDatagramSize = 255*160; // Based on 7 bit encoding
williamr@2
    34
/** WAP SMS Protocol Module service information flags. */
williamr@2
    35
const TUint KWAPSMSDatagramServiceInfo = KSIConnectionLess | KSIMessageBased;
williamr@2
    36
/** CDMA WAP SMS Protocol Module address family ID for legacy WDP application. */
williamr@2
    37
const TUint KWAPCDMASMSAddrFamily=0x013;
williamr@2
    38
williamr@2
    39
/**
williamr@4
    40
 *  @publishedAll
williamr@2
    41
 */
williamr@2
    42
_LIT(KWAPSMSProtocolId,"WAPSMS Datagram");
williamr@2
    43
_LIT(KWAPCDMASMSProtocolId,"WAP CDMA SMS Datagram");
williamr@2
    44
williamr@4
    45
//
williamr@2
    46
// Wap Address / Port Settings
williamr@4
    47
//
williamr@2
    48
williamr@2
    49
/** WAP port setting. */
williamr@2
    50
enum TWapPortNumber
williamr@2
    51
	{
williamr@2
    52
	/** Unspecified. */
williamr@2
    53
	EWapPortUnspecified = -1,
williamr@2
    54
	/** Connectionless session protocol. */
williamr@2
    55
	EWapPortWsp         = 9200,
williamr@2
    56
	/** Connection oriented session protocol. */
williamr@2
    57
	EWapPortWspWtp      = 9201,
williamr@2
    58
	/** Secure connectionless session protocol. */
williamr@2
    59
	EWapPortWspWtls     = 9202,
williamr@2
    60
	/** Secure connection oriented session protocol. */
williamr@2
    61
	EWapPortWspWtpWtls  = 9203,
williamr@2
    62
	/** vCard. */
williamr@2
    63
	EWapPortVCard       = 9204,
williamr@2
    64
	/** Secure vCard. */
williamr@2
    65
	EWapPortVCardWtls   = 9206,
williamr@2
    66
	/** vCal. */
williamr@2
    67
	EWapPortVCal        = 9205,
williamr@2
    68
	/** Secure vCal. */
williamr@2
    69
	EWapPortVCalWtls    = 9207
williamr@2
    70
	};
williamr@2
    71
williamr@2
    72
williamr@2
    73
/**
williamr@2
    74
 *  Socket address type used with the WAP SMS Protocol Module.
williamr@2
    75
 *  @publishedAll
williamr@2
    76
 *  @released
williamr@2
    77
 */
williamr@2
    78
class TWapAddr : public TSockAddr
williamr@2
    79
	{
williamr@2
    80
public:
williamr@2
    81
	enum { EMaxWapAddressLength = 24 };
williamr@2
    82
public:
williamr@2
    83
	/**
williamr@2
    84
	 *  Gets the WAP port number.
williamr@2
    85
	 *  
williamr@2
    86
	 *  	* @return	WAP port number 
williamr@2
    87
	 */
williamr@2
    88
	inline TWapPortNumber WapPort() const;
williamr@2
    89
williamr@2
    90
	/**
williamr@2
    91
	 *  Sets the WAP port number.
williamr@2
    92
	 *  
williamr@2
    93
	 *  	* @param aPort	WAP port number 
williamr@2
    94
	 */
williamr@2
    95
	inline void SetWapPort(TWapPortNumber aPort);
williamr@2
    96
williamr@2
    97
	/**
williamr@2
    98
	 *  Sets the WAP address.
williamr@2
    99
	 *  
williamr@2
   100
	 *  	* @param aTel	WAP address 
williamr@2
   101
	 */
williamr@2
   102
	inline void SetWapAddress(const TDesC8& aTel);
williamr@2
   103
williamr@2
   104
	/**
williamr@2
   105
	 *  Gets the WAP address.
williamr@2
   106
	 *  
williamr@2
   107
	 *  	* @return	WAP address 
williamr@2
   108
	 */
williamr@2
   109
	inline TPtrC8 WapAddress() const;
williamr@2
   110
williamr@2
   111
	/**
williamr@2
   112
	 *  Equality operator.
williamr@2
   113
	 *  
williamr@2
   114
	 *  @param aAddr	Object to compare
williamr@2
   115
	 *  	* @return		ETrue if the object value's are equal 
williamr@2
   116
	 */
williamr@2
   117
	inline TBool operator==(const TWapAddr& aAddr) const;
williamr@2
   118
	};
williamr@2
   119
williamr@4
   120
//
williamr@2
   121
// Option Settings
williamr@4
   122
//
williamr@2
   123
williamr@2
   124
/** WAP SMS Protocol Module option level, for RSocket::SetOpt() and RSocket::GetOpt() calls. */
williamr@2
   125
const TInt KWapSmsOptionLevel = KSOLSocket + 1;
williamr@2
   126
williamr@2
   127
/**
williamr@2
   128
 *  WAP SMS Protocol Module option for the data coding scheme.
williamr@2
   129
 *  
williamr@2
   130
 *  * anOption in RSocket::GetOpt() and RSocket::SetOpt() should be a TWapSmsDataCodingScheme value. 
williamr@2
   131
 */
williamr@2
   132
const TInt KWapSmsOptionNameDCS      = 0x01;
williamr@2
   133
williamr@2
   134
/** Unused. */
williamr@2
   135
const TInt KWapSmsOptionSmartMessage = 0x02;
williamr@2
   136
williamr@2
   137
/** WAP SMS Protocol Module option to set the message type to WAP datagram. */
williamr@2
   138
const TInt KWapSmsOptionWapDatagram  = 0x03;
williamr@2
   139
williamr@2
   140
/** WAP SMS Protocol Module option to set the status report of the last segment. */
williamr@2
   141
const TInt KWapSmsStatusReportScheme = 0x06;	//	KWapSmsOptionNewStyleClient	= 0x04;
williamr@2
   142
												// KWapSmsOptionOKToDeleteMessage = 0x05;
williamr@2
   143
												// Defined in wap_sock.h
williamr@2
   144
williamr@2
   145
williamr@2
   146
/**
williamr@2
   147
 *  WAP Data Coding Scheme types.
williamr@2
   148
 *  
williamr@2
   149
 *  * These are used with KWapSmsOptionNameDCS. 
williamr@2
   150
 */
williamr@2
   151
enum TWapSmsDataCodingScheme
williamr@2
   152
	{
williamr@2
   153
	/** 7-bit. */
williamr@2
   154
	EWapSms7BitDCS,
williamr@2
   155
	/** 8-bit. */
williamr@2
   156
	EWapSms8BitDCS
williamr@2
   157
	};
williamr@2
   158
	
williamr@2
   159
williamr@2
   160
/** WAP Status Report Scheme types.
williamr@2
   161
*
williamr@2
   162
* These are used with KWapSmsStatusReportScheme. */
williamr@2
   163
enum TWapSmsStatusReportScheme
williamr@2
   164
	{
williamr@2
   165
	/** Default Scheme. */
williamr@2
   166
	EWapSmsDefault,
williamr@2
   167
	/** TPSRR Scheme. */
williamr@2
   168
	EWapSmsTPSRR,
williamr@2
   169
	/** Control Information Element Scheme. */
williamr@2
   170
	EWapSmsCtrlInfoElement
williamr@2
   171
	};
williamr@2
   172
williamr@2
   173
#include "es_wsms.inl"
williamr@2
   174
williamr@2
   175
#endif