API Documentation
Back to top  

ClusteredSessionStore

A session store which stores sessions in a distributed map so they are available across the cluster.

package

Default

Methods

__construct

__construct()

Remove all sessions from the store.

clear( $arg0) : void

Arguments

$arg0

callable

Close the store

close() : void

Create a session store

create( $arg0,  $arg1 = null,  $arg2 = null) : \io\vertx\jphp\ext\web\sstore\ClusteredSessionStore
static

param $vertx [Vertx] the Vert.x instance create($vertx)

Create a session store

param $vertx [Vertx] the Vert.x instance param $sessionMapName [string] the session map name create($vertx, $sessionMapName)

Create a session store.

The retry timeout value, configures how long the session handler will retry to get a session from the store when it is not found.

param $vertx [Vertx] the Vert.x instance param $retryTimeout [integer] the store retry timeout, in ms create($vertx, $retryTimeout)

Create a session store.

The retry timeout value, configures how long the session handler will retry to get a session from the store when it is not found.

param $vertx [Vertx] the Vert.x instance param $sessionMapName [string] the session map name param $retryTimeout [integer] the store retry timeout, in ms create($vertx, $sessionMapName, $retryTimeout)

Arguments

$arg0

Vertx

$arg1

string | integer

$arg2

integer

Response

\io\vertx\jphp\ext\web\sstore\ClusteredSessionStore

the session store

Create a new session using the default min length.

createSession( $arg0,  $arg1 = null) : \io\vertx\jphp\ext\web\sstore\Session

param $timeout [integer] - the session timeout, in ms createSession($timeout)

Create a new session.

param $timeout [integer] - the session timeout, in ms param $length [integer] - the required length for the session id createSession($timeout, $length)

Arguments

$arg0

integer

$arg1

integer

Response

\io\vertx\jphp\ext\web\sstore\Session

the session

Delete the session with the specified ID.

delete( $arg0,  $arg1) : void

Arguments

$arg0

string

$arg1

callable

Get the session with the specified ID.

get( $arg0,  $arg1) : void

Arguments

$arg0

string

$arg1

callable

Initialize this store.

init( $arg0,  $arg1) : $this

Arguments

$arg0

Vertx

$arg1

array

Response

$this

self

Add a session with the specified ID.

put( $arg0,  $arg1) : void

Arguments

$arg0

Session

$arg1

callable

The retry timeout value in milli seconds used by the session handler when it retrieves a value from the store.<p/>

retryTimeout() : integer

A non positive value means there is no retry at all.

Response

integer

the timeout value, in ms

Get the number of sessions in the store.

size( $arg0) : void

Beware of the result which is just an estimate, in particular with distributed session stores.

Arguments

$arg0

callable

Constants

Default length for a session id.

DEFAULT_SESSIONID_LENGTH

More info: https://www.owasp.org/index.php/Session_Management_Cheat_Sheet

var

php文件只是为了写代码方便，常量的实际值请参考原java文件

The default name used for the session map

DEFAULT_SESSION_MAP_NAME
var

php文件只是为了写代码方便，常量的实际值请参考原java文件

Default retry time out, in ms, for a session not found in this store.

DEFAULT_RETRY_TIMEOUT
var

php文件只是为了写代码方便，常量的实际值请参考原java文件