SFBSSL

Wrapper Class for the ISSL interface.

#include <SFBSSL.h.hpp>

class SFBSSL : public SFBWebOpts;

SFMTYPEDEFWRAPPER(SFBSSL)

Inheritance diagram

Version

BREW 2.0	BREW 2.1	BREW 3.1	BREW 4.0
O	O	O	O

Reference

BREW API ISSL

Member

Public Functions
`Void`	Close( `SSLInfo*` info , `SFXCallbackPtr` callback ) Close the SSL session.
`Void`	Negotiate( `SSLInfo*` info , `SFBX509ChainSmpPtr` certs , `SFXCallbackPtr` callback , `...` ) Progress SSL handshaking. If a handshake has not started it starts it. If one is in progress it continues it. If one has been established it reports the state of it in relation to what was requested.
`Void`	NegotiateV( `SSLInfo *` info , `SFBX509ChainSmpPtr` certs , `SFXCallbackPtr` callback , `WebOptPtr` opts ) The function causes SSL handshaking to progress.
static `SFBSSLSmp`	NewInstance( `SFCErrorPtr` exception = null ) Create a new SFBSSL instance.
static `SFBSSLSmp`	NewInstance( `AEECLSID` id , `SFCErrorPtr` exception = null ) Create a new SFBSSL instance.
`Void`	Renegotiate( `SSLInfo*` info , `SFBX509ChainSmpPtr` certs , `SFXCallbackPtr` callback , `...` ) Renegotiate is exactly the same except it will redo the negotiation if a connection is established. Renegotiate is currently not supported.
`Void`	RenegotiateV( `SSLInfo *` info , `SFBX509ChainSmpPtr` certs , `SFXCallbackPtr` callback , `WebOptPtr` opts ) The function causes SSL handshaking to progress.
`Void`	SetSocket( `SFBSocketSmpConstRef` socket ) Set the socket open and connected to the SSL server.
`SFCError`	AddOpt( `WebOptPtr` opts ) (inherits from SFBWebOpts) Add the list of WebOpts to the current web option set.
`SFCError`	GetOpt( `SInt32` id , `SInt32` index , `WebOptPtr` opt ) (inherits from SFBWebOpts) Get a WebOpt in the list of WebOpts in SFBWebOpts instance matching OptId in.
`SFCError`	QueryInterface( `AEECLSID` clsid , `VoidHandle` handle ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`SFCError`	QueryInterface( `AEECLSID` clsid , `SFBBaseSmpPtr` handle ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`SFBBaseSmp`	QueryInterface( `AEECLSID` clsid ) (inherits from SFBQuery) Ask an object for another API contract from the object in question.
`SFCError`	RemoveOpt( `SInt32` id , `SInt32` index ) (inherits from SFBWebOpts) Remove the nIndex'th WebOpt matching OptId.
`Void`	Self( `AEECLSID` clsidReq , `SFBQuerySmpPtr` clone , `AEECLSID` clsidImp ) (inherits from SFBQuery) Helper macro for those implementing an object with a single interface.
`SFBQuerySmp`	Self( `AEECLSID` clsidReq , `AEECLSID` clsidImp ) (inherits from SFBQuery) Helper macro for those implementing an object with a single interface.

Protected Functions
static `SFBBaseSmp`	FactoryByCreate( `AEECLSID` id , `SFCErrorPtr` exception = null ) (inherits from SFBBase) Create the instance for the specified ClassID's interface.
static `SFBBaseSmp`	FactoryByQuery( `SFBQuerySmpConstRef` query , `AEECLSID` id , `SFCErrorPtr` exception = null ) (inherits from SFBBase) Create the instance for the specified ClassID's interface using the SFBQuery instance.

SFBSSL::Close

Close the SSL session.

[ public ]
Void Close(
    SSLInfo* info             // place to put the response structure 
    SFXCallbackPtr callback   // place to call back when SSL, suceeds, fails or needs help 
);

Reference

BREW API ISSL_Close | SSLInfo | SSLSecurityInfo | X509TrustResult

SFBSSL::Negotiate

Progress SSL handshaking. If a handshake has not started it starts it. If one is in progress it continues it. If one has been established it reports the state of it in relation to what was requested.

[ public ]
Void Negotiate(
    SSLInfo* info              // place to put the response structure 
    SFBX509ChainSmpPtr certs   // place to return cert chain
    SFXCallbackPtr callback    // place to call back when SSL, suceeds, fails or needs help
    ...                        // the set of options against which negotiation is performed
);

Reference

BREW API ISSL_Negotiate | SFBX509Chain::Verify

SFBSSL::NegotiateV

The function causes SSL handshaking to progress.

[ public ]
Void NegotiateV(
    SSLInfo * info             // place to put the response structure 
    SFBX509ChainSmpPtr certs   // place to return cert chain
    SFXCallbackPtr callback    // place to call back when SSL, suceeds, fails or needs help
    WebOptPtr opts             // the set of options against which negotiation is performed
);

Reference

BREW API ISSL_NegotiateV | SSLInfo | SFBSSL::Negotiate | SFBSSL::Renegotiate | SFBSSL::RenegotiateV

SFBSSL::NewInstance

Create a new SFBSSL instance.

[ public, static ]
SFBSSLSmp NewInstance(
    SFCErrorPtr exception = null   // Error
);

[ public, static ]
SFBSSLSmp NewInstance(
    AEECLSID id                    // Class ID
    SFCErrorPtr exception = null   // Error
);

SFBSSL::Renegotiate

Renegotiate is exactly the same except it will redo the negotiation if a connection is established. Renegotiate is currently not supported.

[ public ]
Void Renegotiate(
    SSLInfo* info              // place to put the response structure 
    SFBX509ChainSmpPtr certs   // place to return cert chain
    SFXCallbackPtr callback    // place to call back when SSL, suceeds, fails or needs help
    ...                        // the set of options against which negotiation is performed
);

Reference

BREW API ISSL_Renegotiate | SFBSSL::Negotiate | SFBSSL::NegotiateV | SFBSSL::Renegotiate

SFBSSL::RenegotiateV

The function causes SSL handshaking to progress.

[ public ]
Void RenegotiateV(
    SSLInfo * info             // place to put the response structure 
    SFBX509ChainSmpPtr certs   // place to return cert chain
    SFXCallbackPtr callback    // place to call back when SSL, suceeds, fails or needs help
    WebOptPtr opts             // the set of options against which negotiation is performed
);

Description

Renegotiate is exactly the same except it will redo the negotiation if a connection is established.

Reference

BREW API ISSL_RenegotiateV | SFBSSL::Negotiate | SFBSSL::NegotiateV | SFBSSL::Renegotiate

SFBSSL::SetSocket

Set the socket open and connected to the SSL server.

[ public ]
Void SetSocket(
    SFBSocketSmpConstRef socket   // pointer to open socket
);

Reference

BREW API ISSL_SetSocket