Class List Method List File List

# Class: VertxWeb::ClusteredSessionStore

Inherits:
  SessionStore
  - Object
  - SessionStore
  - VertxWeb::ClusteredSessionStore
  show all
Defined in:
  /Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/clustered_session_store.rb

## Overview

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

## Class Method Summary (collapse)

- + (::VertxWeb::ClusteredSessionStore) create(param_1 = nil, param_2 = nil, param_3 = nil)
  Create a session store.

### Methods inherited from SessionStore

#clear, #close, #create_session, #delete, #get, #put, #retry_timeout, #size

## Class Method Details

### + (`::VertxWeb::ClusteredSessionStore`) create(vertx) + (`::VertxWeb::ClusteredSessionStore`) create(vertx, sessionMapName) + (`::VertxWeb::ClusteredSessionStore`) create(vertx, retryTimeout) + (`::VertxWeb::ClusteredSessionStore`) create(vertx, sessionMapName, 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.

Overloads:

- + (`::VertxWeb::ClusteredSessionStore`) create(vertx)

  Parameters:

  - vertx (`::Vertx::Vertx`) —
    the Vert.x instance
- + (`::VertxWeb::ClusteredSessionStore`) create(vertx, sessionMapName)

  Parameters:

  - vertx (`::Vertx::Vertx`) —
    the Vert.x instance
  - sessionMapName (`String`) —
    the session map name
- + (`::VertxWeb::ClusteredSessionStore`) create(vertx, retryTimeout)

  Parameters:

  - vertx (`::Vertx::Vertx`) —
    the Vert.x instance
  - retryTimeout (`Fixnum`) —
    the store retry timeout, in ms
- + (`::VertxWeb::ClusteredSessionStore`) create(vertx, sessionMapName, retryTimeout)

  Parameters:

  - vertx (`::Vertx::Vertx`) —
    the Vert.x instance
  - sessionMapName (`String`) —
    the session map name
  - retryTimeout (`Fixnum`) —
    the store retry timeout, in ms

Returns:

- (`::VertxWeb::ClusteredSessionStore`) —
  the session store

Raises:

- (`ArgumentError`)

    36
    37
    38
    39
    40
    41
    42
    43
    44
    45
    46
    47
    # File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/clustered_session_store.rb', line 36

    def self.create(param_1=nil,param_2=nil,param_3=nil)
      if param_1.class.method_defined?(:j_del) && !block_given? && param_2 == nil && param_3 == nil
        return ::Vertx::Util::Utils.safe_create(Java::IoVertxExtWebSstore::ClusteredSessionStore.java_method(:create, [Java::IoVertxCore::Vertx.java_class]).call(param_1.j_del),::VertxWeb::ClusteredSessionStore)
      elsif param_1.class.method_defined?(:j_del) && param_2.class == String && !block_given? && param_3 == nil
        return ::Vertx::Util::Utils.safe_create(Java::IoVertxExtWebSstore::ClusteredSessionStore.java_method(:create, [Java::IoVertxCore::Vertx.java_class,Java::java.lang.String.java_class]).call(param_1.j_del,param_2),::VertxWeb::ClusteredSessionStore)
      elsif param_1.class.method_defined?(:j_del) && param_2.class == Fixnum && !block_given? && param_3 == nil
        return ::Vertx::Util::Utils.safe_create(Java::IoVertxExtWebSstore::ClusteredSessionStore.java_method(:create, [Java::IoVertxCore::Vertx.java_class,Java::long.java_class]).call(param_1.j_del,param_2),::VertxWeb::ClusteredSessionStore)
      elsif param_1.class.method_defined?(:j_del) && param_2.class == String && param_3.class == Fixnum && !block_given?
        return ::Vertx::Util::Utils.safe_create(Java::IoVertxExtWebSstore::ClusteredSessionStore.java_method(:create, [Java::IoVertxCore::Vertx.java_class,Java::java.lang.String.java_class,Java::long.java_class]).call(param_1.j_del,param_2,param_3),::VertxWeb::ClusteredSessionStore)
      end
      raise ArgumentError, "Invalid arguments when calling create(param_1,param_2,param_3)"
    end