Collapse all Symbian^3 Application Developer Library

CUpnpSocketShutdown Class Reference

class CUpnpSocketShutdown : private CActive

Inherits from

CUpnpSocketShutdown
- CActive
  - CBase

Public Member Functions
	~CUpnpSocketShutdown ()
void	HandleError ( TInt )
void	MarksTimeout ()
CUpnpSocketShutdown *	NewL ( CUpnpTcpSession &, RSocket &, TThreadPriority )
void	ShutdownImmediate ()
void	ShutdownStop ()

Private Member Functions
	CUpnpSocketShutdown ( CUpnpTcpSession &, RSocket &, TThreadPriority )
void	ConstructL ()
void	DoCancel ()
TInt	RunError ( TInt )
void	RunL ()
void	TimerEventL ( CUpnpNotifyTimer *)

Inherited Functions
	CActive::CActive(TInt)
	CActive::Cancel()
	CActive::Deque()
	CActive::Extension_(TUint,TAny &,TAny )
	CActive::IsActive()const
	CActive::IsAdded()const
	CActive::Priority()const
	CActive::SetActive()
	CActive::SetPriority(TInt)
	CActive::~CActive()
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Private Member Enumerations
enum	TInternalState { EUnknown , EShuttingDownStopOutput , EShuttingDownNormal , EWaitingForInputError , EInputErrorReceived , ENotConnected }

Inherited Enumerations
	CActive:TPriority

Private Attributes
CUpnpNotifyTimer *	iInputTimeoutTimer
TInternalState	iInternalState
CUpnpTcpSession &	iSession
TBool	iSessionTimeouted
RSocket &	iSocket

Inherited Attributes
	CActive::iStatus

Constructor & Destructor Documentation

CUpnpSocketShutdown(CUpnpTcpSession &, RSocket &, TThreadPriority)

CUpnpSocketShutdown	(	CUpnpTcpSession &	,
		RSocket &	,
		TThreadPriority
	)	[private]

Constructor

Parameters

CUpnpTcpSession &
RSocket &
TThreadPriority

~CUpnpSocketShutdown()

~CUpnpSocketShutdown

(

)

Destructor.

Member Functions Documentation

ConstructL()

void

ConstructL

(

)

[private]

ConstructL

DoCancel()

void

DoCancel

(

)

[private, virtual]

DoCancel Cancel outstanding request(s) and reset the iActive flag.

Since: Series60 2.0

HandleError(TInt)

void

HandleError

(

TInt

aError

)

HandleError Error servicing

Since: Series60 3.1

Parameters

TInt aError

Error code

MarksTimeout()

void

MarksTimeout

(

)

MarksTimeout Marks if timeout occured on session

Since: Series60 3.2

NewL(CUpnpTcpSession &, RSocket &, TThreadPriority)

CUpnpSocketShutdown *	NewL	(	CUpnpTcpSession &	,
			RSocket &	,
			TThreadPriority
		)	[static]

Constructor function.

Since: Series60 3.1

Parameters

CUpnpTcpSession &
RSocket &
TThreadPriority

RunError(TInt)

TInt

RunError

(

TInt

aError

)

[private, virtual]

RunError RunError in case RunL leaves.

Since: Series60 2.0

Parameters

TInt aError

RunL()

void

RunL

(

)

[private, virtual]

RunL Active object state machine.

Since: Series60 2.0

ShutdownImmediate()

void

ShutdownImmediate

(

)

ShutdownImmediate Shutdown with EImmediate

Since: Series60 3.1

ShutdownStop()

void

ShutdownStop

(

)

ShutdownStop Shutdown with ENormal or EStopOutput

Since: Series60 3.1

TimerEventL(CUpnpNotifyTimer *)

void

TimerEventL

(

CUpnpNotifyTimer *

aTimer

)

[private]

Callback function for timer expirations.

Since: Series60 2.6

Parameters

CUpnpNotifyTimer * aTimer

Timer that has expired.

Member Enumerations Documentation

Enum TInternalState

TInternalState Internal states.

Since: Series60 3.1

Enumerators

EUnknown
EShuttingDownStopOutput
EShuttingDownNormal
EWaitingForInputError
EInputErrorReceived
ENotConnected

Member Data Documentation

CUpnpNotifyTimer * iInputTimeoutTimer

CUpnpNotifyTimer *

iInputTimeoutTimer

[private]

TInternalState iInternalState

TInternalState

iInternalState

[private]

Internal state variable.

CUpnpTcpSession & iSession

CUpnpTcpSession &

iSession

[private]

Reference to session that owns the writer. Session is request writing and is notified when it's finished or errors occure, not owned.

TBool iSessionTimeouted

TBool

iSessionTimeouted

[private]

Determines if timeout occured on session

RSocket & iSocket

RSocket &

iSocket

[private]

Socket used for writing data, not owned.