Documentation

CommunicationProvider

Class CommunicationProvider is for internal use to communicate with FileMaker Server.

Tags
link

GitHub Repository

version
37
author

Masayuki Nii nii@msyk.net

copyright

2017-2026 Masayuki Nii (Claris FileMaker is registered trademarks of Claris International Inc. in the U.S. and other countries.)

Table of Contents

Methods

endCommunication()  : void
Finish a communication scope.
startCommunication()  : void
Start a communication scope with a shared authenticated session.
_createCurlHandle()  : CurlHandle
To create and configure cURL at a single place, avoiding code redundancy.
cacheKey()  : string

Methods

endCommunication()

Finish a communication scope.

public endCommunication() : void

Without a session cache, the authenticated session is ended and the server session is logged out.

With a session cache, if the token currently held by this instance matches the one in the cache, its TTL is renewed and the session is left alive. If another process has replaced the cached token in the meantime, this instance's now-stale token is considered orphaned and logged out at the server, leaving the newer cached token intact.

Tags
throws
Exception

In case of any error, an exception arises.

startCommunication()

Start a communication scope with a shared authenticated session.

public startCommunication() : void

Without a session cache, a new authenticated session is created and kept for the duration of the current communication scope.

With a session cache, the cached session token is reused if available, avoiding a new login against the FileMaker Server. If no cached token is found, a new session is created and stored in the cache for future reuse.

Tags
throws
Exception

In case of any error, an exception arises.

_createCurlHandle()

To create and configure cURL at a single place, avoiding code redundancy.

private _createCurlHandle(string $url) : CurlHandle
Parameters
$url : string

The URL you want to access.

Return values
CurlHandle

        
On this page

Search results