InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
CusHttpLnkLinkResourceConnection Class Reference
Inheritance diagram for CusHttpLnkLinkResourceConnection:
CPMUnknown< IHTTPLinkResourceConnection >IHTTPLinkResourceConnectionIPMUnknown

Public Types

typedef CPMUnknown
< IHTTPLinkResourceConnection
inherited
 

Public Member Functions

 CusHttpLnkLinkResourceConnection (IPMUnknown *boss)
 
 ~CusHttpLnkLinkResourceConnection ()
 
virtual bool16 Shutdown ()
 
virtual bool16 IsConnected () const
 
virtual bool16 Connect ()
 
virtual bool16 IsAuthorized () const
 
virtual bool16 Reconnect ()
 
virtual bool16 Disconnect ()
 
virtual
IHTTPLinkResourceConnection::ConnectionId 
GetConnectionId ()
 
virtual bool16 GetLoginCredentials (std::stringstream &loginInformation) const
 
virtual bool16 SetLoginCredentials (const std::stringstream &loginInformation)
 
virtual void ReadWriteSnapshotForBackgroundThread (IPMStream *s)
 
- Public Member Functions inherited from CPMUnknown< IHTTPLinkResourceConnection >
IPMUnknownQueryInterface (PMIID interfaceID) const
 
void AddRef () const
 
void Release () const
 
void PreDirty (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
 
void PreDirtyNoMessage (ImplementationID prop=kInvalidImpl, bool16 allowModification=kTrue)
 
 CPMUnknown (const CPMUnknown &)=delete
 
CPMUnknownoperator= (const CPMUnknown &)=delete
 

Additional Inherited Members

- Protected Member Functions inherited from CPMUnknown< IHTTPLinkResourceConnection >
 CPMUnknown (IPMUnknown *boss)
 
- Protected Attributes inherited from CPMUnknown< IHTTPLinkResourceConnection >
HelperInterface fHelperInterface
 

Detailed Description

Provide methods to authorize connection to server

Constructor & Destructor Documentation

CusHttpLnkLinkResourceConnection::CusHttpLnkLinkResourceConnection (IPMUnknownboss)

Constructor

CusHttpLnkLinkResourceConnection::~CusHttpLnkLinkResourceConnection ()

Destructor

Member Function Documentation

bool16 CusHttpLnkLinkResourceConnection::Connect ()
virtual

Checks if the current connection is authorized

Returns
kTrue if the Http Connection is authorized else kFalse.

Implements IHTTPLinkResourceConnection.

bool16 CusHttpLnkLinkResourceConnection::Disconnect ()
virtual

Disconnects the current connection

Returns
kTrue if the connection is diconnected else kFalse

Implements IHTTPLinkResourceConnection.

IHTTPLinkResourceConnection::ConnectionId CusHttpLnkLinkResourceConnection::GetConnectionId ()
virtual

Fetches the connection ID for the current connection

Returns
ConnectionId for the current connection

Implements IHTTPLinkResourceConnection.

bool16 CusHttpLnkLinkResourceConnection::GetLoginCredentials (std::stringstream & loginInformation) const
virtual

Gets the login credentials for the given connection

Parameters
loginInformation[OUT] The login information that requires to be set for the given connection
Returns
kFalse if credentials could not be encoded, else kTrue

Implements IHTTPLinkResourceConnection.

bool16 CusHttpLnkLinkResourceConnection::IsAuthorized () const
virtual

Creates/Logs-in the current connection

Returns
kTrue if connection is created/logged-in successfully else kFalse.

Implements IHTTPLinkResourceConnection.

bool16 CusHttpLnkLinkResourceConnection::IsConnected () const
virtual

Checks if the current connection is connected

Returns
kTrue if the Http Connection is connected else kFalse

Implements IHTTPLinkResourceConnection.

virtual void CusHttpLnkLinkResourceConnection::ReadWriteSnapshotForBackgroundThread (IPMStreams)
inlinevirtual

For internal purpose only

Implements IHTTPLinkResourceConnection.

bool16 CusHttpLnkLinkResourceConnection::Reconnect ()
virtual

Reconnects the current connection

Returns
kTrue if re-connection is successful else kFalse

Implements IHTTPLinkResourceConnection.

bool16 CusHttpLnkLinkResourceConnection::SetLoginCredentials (const std::stringstream & loginInformation)
virtual

Sets the login credentials for the given connection

Parameters
loginInformation[IN] The login information that requires to be set for the given connection
Returns
kTrue if credentials are set

Implements IHTTPLinkResourceConnection.

bool16 CusHttpLnkLinkResourceConnection::Shutdown (void )
virtual

Shuts down the current connection

Returns
kTrue if the Http Connection is shutdown else kFalse

Implements IHTTPLinkResourceConnection.