epoc32/include/ss_std.inl
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) 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@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
// CSocketServer
williamr@2
    15
// 
williamr@2
    16
//
williamr@2
    17
williamr@2
    18
inline CWorkerThread& CSocketServer::WorkerThread() const 
williamr@2
    19
	{
williamr@2
    20
	return *iOwnerThread;
williamr@2
    21
	};
williamr@2
    22
williamr@2
    23
inline TWorkerId CSocketServer::WorkerId() const
williamr@2
    24
	{
williamr@2
    25
	return WorkerThread().WorkerId();
williamr@2
    26
	}
williamr@2
    27
williamr@2
    28
//
williamr@2
    29
// CSockSession
williamr@2
    30
//
williamr@2
    31
williamr@2
    32
inline const CDealer& CSockSession::Dealer() const 
williamr@2
    33
	{ 
williamr@2
    34
	// NB: this is really only a static_cast<> but the Gordian knot of class dependencies results in a forward
williamr@2
    35
	// declaration
williamr@2
    36
	return *reinterpret_cast<const CDealer*>(Server());	
williamr@2
    37
	}
williamr@2
    38
williamr@2
    39
inline CSubSessionIx& CSockSession::SubSessions()
williamr@2
    40
	{
williamr@2
    41
	return iSubSessions;
williamr@2
    42
	}
williamr@2
    43
williamr@2
    44
inline const CSubSessionIx& CSockSession::SubSessions() const
williamr@2
    45
	{
williamr@2
    46
	return iSubSessions;
williamr@2
    47
	}
williamr@2
    48
williamr@2
    49
inline TSockManData* CSockSession::SockManGlobals() const
williamr@2
    50
    {
williamr@2
    51
        return WorkerThread().SockManGlobals();
williamr@2
    52
    }
williamr@2
    53
williamr@2
    54
//
williamr@2
    55
// CSockSubSession
williamr@2
    56
//
williamr@2
    57
williamr@2
    58
inline void CSockSubSession::Open()
williamr@2
    59
	{
williamr@2
    60
	iAccessCount++;
williamr@2
    61
	}
williamr@2
    62
williamr@2
    63
inline void CSockSubSession::Close()
williamr@2
    64
	{
williamr@2
    65
	iAccessCount--;
williamr@2
    66
	ASSERT(iAccessCount >= 0);
williamr@2
    67
	if(iAccessCount == 0)
williamr@2
    68
		{
williamr@2
    69
		RemoveAndDestroy();
williamr@2
    70
		}
williamr@2
    71
	}
williamr@2
    72
williamr@2
    73
inline TInt CSockSubSession::AccessCount() const
williamr@2
    74
	{
williamr@2
    75
	return iAccessCount;
williamr@2
    76
	}
williamr@2
    77
williamr@2
    78
inline CSockSession* CSockSubSession::Session()
williamr@2
    79
	{ 
williamr@2
    80
	ASSERT(iSession); 
williamr@2
    81
	return iSession;
williamr@2
    82
	}
williamr@2
    83
williamr@2
    84
inline CPlayer& CSockSubSession::Player() const 
williamr@2
    85
	{ 
williamr@2
    86
	ASSERT(iPlayer); 
williamr@2
    87
	return *iPlayer; 
williamr@2
    88
	}
williamr@2
    89
williamr@2
    90
#ifdef SYMBIAN_NETWORKING_PERFMETRICS
williamr@2
    91
inline void CSockSubSession::IncludePerformanceData(TInt aDeltaClientRxBytes, TInt aDeltaClientRxBuffBytes, TInt aDeltaClientTxBytes)
williamr@2
    92
	{
williamr@2
    93
	iSession->IncludePerformanceData(aDeltaClientRxBytes, aDeltaClientRxBuffBytes, aDeltaClientTxBytes);
williamr@2
    94
	}
williamr@2
    95
#endif
williamr@2
    96
williamr@2
    97
williamr@2
    98
inline const RMessage2& CSockSession::Message() const
williamr@2
    99
	{ 
williamr@2
   100
	return *iOurMessage; 
williamr@2
   101
	}
williamr@2
   102
	
williamr@2
   103
inline void CSockSession::CompleteDisconnect()
williamr@2
   104
	{
williamr@2
   105
	RMessage2 dm = iDisconnectMessage;
williamr@2
   106
	inherited::Disconnect(dm);
williamr@2
   107
	}
williamr@2
   108
williamr@2
   109
williamr@2
   110
inline void CSocketScheduler::SetGlobals(TSockManData* aGlobals)
williamr@2
   111
    { 
williamr@2
   112
	static_cast<CSocketScheduler*>(CActiveScheduler::Current())->iGlobals = aGlobals; 
williamr@2
   113
	}
williamr@2
   114
williamr@2
   115
//inline void CSocketScheduler::SetWaitHook(TCallBack* aCall)
williamr@2
   116
//	{ ((CSocketScheduler*)CActiveScheduler::Current())->iWaitHook=aCall; }
williamr@2
   117
williamr@2
   118
inline TSockManData* CSocketScheduler::Globals()
williamr@2
   119
	{ 
williamr@2
   120
	return static_cast<CSocketScheduler*>(CActiveScheduler::Current())->iGlobals; 
williamr@2
   121
	}
williamr@2
   122
williamr@2
   123
//
williamr@2
   124
// CSubSessionIx
williamr@2
   125
// 
williamr@2
   126
williamr@2
   127
/**
williamr@2
   128
Optional locking. When accessing any of the public methods of this class in a multithreaded 
williamr@2
   129
environment, locking is often necessary. This lock does not allow for lock nesting.
williamr@2
   130
*/
williamr@2
   131
inline void CSubSessionIx::Lock() const
williamr@2
   132
	{ 
williamr@2
   133
	iLock.Wait(); 
williamr@2
   134
	}
williamr@2
   135
williamr@2
   136
/**
williamr@2
   137
Unlocking.
williamr@2
   138
@see Lock()
williamr@2
   139
*/
williamr@2
   140
inline void CSubSessionIx::Unlock() const
williamr@2
   141
	{ 
williamr@2
   142
	iLock.Signal(); 
williamr@2
   143
	}
williamr@2
   144
williamr@2
   145
/**
williamr@2
   146
@return the number of active sub-sessions in the container.
williamr@2
   147
*/
williamr@2
   148
inline TInt CSubSessionIx::ActiveCount() const
williamr@2
   149
	{
williamr@2
   150
	return iActiveCount;
williamr@2
   151
	}