Collapse all Symbian^3 Application Developer Library

MGenericSecureSocket Class Reference

class MGenericSecureSocket

Interface to provide Generic Secure Socket Functionality.

Since: v9.2

Public Member Functions
void	CancelRead ()
void	CancelRecv ()
void	CancelSend ()
void	Close ()
TInt	GetOpt ( TUint , TUint , TDes8 &)
void	LocalName ( TSockAddr &)
void	Read ( TDes8 &, TRequestStatus &)
void	Recv ( TDes8 &, TUint , TRequestStatus &)
void	RemoteName ( TSockAddr &)
void	Send (const TDesC8 &, TUint , TRequestStatus &)
TInt	SetOpt ( TUint , TUint , const TDesC8 &)

Member Functions Documentation

CancelRead()

void

CancelRead

(

)

[pure virtual]

Cancel the current read operation

CancelRecv()

void

CancelRecv

(

)

[pure virtual]

Cancel the current recv operation

CancelSend()

void

CancelSend

(

)

[pure virtual]

Cancel the current send operation

Close()

void

(

)

[pure virtual]

Close the Generic Socket

GetOpt(TUint, TUint, TDes8 &)

TInt	GetOpt	(	TUint	aOptionName,
			TUint	aOptionLevel,
			TDes8 &	aOption
		)	[pure virtual]

Gets a socket option

Parameters

TUint aOptionName	An integer constant which identifies an option.
TUint aOptionLevel	An integer constant which identifies level of an option
TDes8 & aOption	Option value packaged in a descriptor.

LocalName(TSockAddr &)

void

LocalName

(

TSockAddr &

aAddr

)

[pure virtual]

Gets the local address of a bound socket.

Parameters

TSockAddr & aAddr

Local address which is filled in on return.

Read(TDes8 &, TRequestStatus &)

void	Read	(	TDes8 &	aDataRead,
			TRequestStatus &	aStatus
		)	[pure virtual]

Read data from the generic socket for the secure socket

Parameters

TDes8 & aDataRead	encrypted data read for the secure socket
TRequestStatus & aStatus	Request Status. On return KErrNone if successful, otherwise another of the system-wide error

Recv(TDes8 &, TUint, TRequestStatus &)

void	Recv	(	TDes8 &	aDataReceived,
			TUint	aFlags,
			TRequestStatus &	aStatus
		)	[pure virtual]

Receive data from the generic socket for the secure socket

Parameters

TDes8 & aDataReceived	encrypted data received for the secure socket
TUint aFlags	Flags which are passed through to protocol
TRequestStatus & aStatus	Request Status. On return KErrNone if successful, otherwise another of the system-wide error

RemoteName(TSockAddr &)

void

RemoteName

(

TSockAddr &

aAddr

)

[pure virtual]

Gets the remote address of a bound socket.

Parameters

TSockAddr & aAddr

Remote address which is filled in on return.

Send(const TDesC8 &, TUint, TRequestStatus &)

void	Send	(	const TDesC8 &	aDataToSend,
			TUint	aFlags,
			TRequestStatus &	aStatus
		)	[pure virtual]

Send data over the generic socket for the secure socket

Parameters

const TDesC8 & aDataToSend	encrypted data to send for secure socket
TUint aFlags	Flags which are passed through to protocol
TRequestStatus & aStatus	Request Status

SetOpt(TUint, TUint, const TDesC8 &)

TInt	SetOpt	(	TUint	aOptionName,
			TUint	aOptionLevel,
			const TDesC8 &	aOption
		)	[pure virtual]

Sets a socket option

Parameters

TUint aOptionName	An integer constant which identifies an option.
TUint aOptionLevel	An integer constant which identifies level of an option
const TDesC8 & aOption	Option value packaged in a descriptor.