client Class APE.Core

Summary

File
<./src/Ape_Jsf/Source/Core/Core.js>

Core Class Detail

APE.Core (options)
Core object, can be extended with sessions

To connect such an instance to a APE server user the start() method.

File:
<./src/Ape_Jsf/Source/Core/Core.js>
Parameters:
{object} options
Options
{string} options.server
APE server URL (default: '')
{integer} options.pollTime
Max time for a request (default: 25000)
{string} options.identifier
Identifier is used by cookie to differentiate ape instance (default: 'ape')
{integer} options.transport:
Transport [0: long polling, 1 : XHRStreaming, 2: JSONP, 3 SSE / JSONP, 4 : SSE / XHR 6: websocket] (default: 0)
{integer} options.frequency
Frequency identifier (default: 0)
{integer} options.cycledStackTime
Time before send request of cycledStack (default: 350)
{boolean} options.secure
Use https instead of http (default:false)
See:
APE.start
APE.ready
APE.load

Summary

Own
Attributes Type Name Description
  {object} user User object

Summary

Own
Methods Attributes Methods Name Methods Description
<static>   APE.Core. delPipe () Delete a pipe from the Core.
<static>   APE.Core. newPipe (type, options) Create a new pipe, or find an existing one by its pubid.

<static> APE.Core. delPipe ()

Delete a pipe from the Core.

Effectively this removes a pipe from the pipe hash and fire event 'pipeDelete'.

Use this function when you no longer need to use a pipe to free the memory.

You should only use this function to delete Uni Pipe (user pipe). The deleting of Multi Pipe (channel pipe) are automatically handled by the Core when you left a Multi Pipe.


<static> {APE.PipeSingle|APE.PipeMulti|APE.PipeProxy} APE.Core. newPipe (type, options)

Create a new pipe, or find an existing one by its pubid.

If options is a pipe with a existing pubid, that pipe will be returned, else a new one will be created for the desired type.

Parameters:
{string} type Can be 'uni', 'multi', 'proxy'
{object} options Optional Option with a pipe.pubid property
Returns: