Class: VertxWeb::LocalSessionStore
- Inherits:
-
SessionStore
- Object
- SessionStore
- VertxWeb::LocalSessionStore
- Defined in:
- /Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/local_session_store.rb
Overview
A session store which is only available on a single node.
Can be used when sticky sessions are being used.
Constant Summary
- @@j_api_type =
Object.new
Class Method Summary (collapse)
- + (Boolean) accept?(obj)
-
+ (::VertxWeb::LocalSessionStore) create(vertx = nil, sessionMapName = nil, reaperInterval = nil)
Create a session store.
- + (Object) j_api_type
- + (Object) j_class
- + (Object) unwrap(obj)
- + (Object) wrap(obj)
Instance Method Summary (collapse)
-
- (void) clear { ... }
Remove all sessions from the store.
-
- (void) close
Close the store.
-
- (::VertxWeb::Session) create_session(timeout = nil, length = nil)
Create a new session.
-
- (void) delete(id = nil) { ... }
Delete the session with the specified ID.
-
- (void) get(id = nil) { ... }
Get the session with the specified ID.
-
- (void) put(session = nil) { ... }
Add a session with the specified ID.
-
- (Fixnum) retry_timeout
The retry timeout value in milli seconds used by the session handler when it retrieves a value from the store.
-
- (void) size { ... }
Get the number of sessions in the store.
Class Method Details
+ (Boolean) accept?(obj)
23 24 25 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/local_session_store.rb', line 23 def @@j_api_type.accept?(obj) obj.class == LocalSessionStore end |
+ (::VertxWeb::LocalSessionStore) create(vertx = nil, sessionMapName = nil, reaperInterval = nil)
Create a session store
121 122 123 124 125 126 127 128 129 130 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/local_session_store.rb', line 121 def self.create(vertx=nil,sessionMapName=nil,reaperInterval=nil) if vertx.class.method_defined?(:j_del) && !block_given? && sessionMapName == nil && reaperInterval == nil return ::Vertx::Util::Utils.safe_create(Java::IoVertxExtWebSstore::LocalSessionStore.java_method(:create, [Java::IoVertxCore::Vertx.java_class]).call(vertx.j_del),::VertxWeb::LocalSessionStore) elsif vertx.class.method_defined?(:j_del) && sessionMapName.class == String && !block_given? && reaperInterval == nil return ::Vertx::Util::Utils.safe_create(Java::IoVertxExtWebSstore::LocalSessionStore.java_method(:create, [Java::IoVertxCore::Vertx.java_class,Java::java.lang.String.java_class]).call(vertx.j_del,sessionMapName),::VertxWeb::LocalSessionStore) elsif vertx.class.method_defined?(:j_del) && sessionMapName.class == String && reaperInterval.class == Fixnum && !block_given? return ::Vertx::Util::Utils.safe_create(Java::IoVertxExtWebSstore::LocalSessionStore.java_method(:create, [Java::IoVertxCore::Vertx.java_class,Java::java.lang.String.java_class,Java::long.java_class]).call(vertx.j_del,sessionMapName,reaperInterval),::VertxWeb::LocalSessionStore) end raise ArgumentError, "Invalid arguments when calling create(#{vertx},#{sessionMapName},#{reaperInterval})" end |
+ (Object) j_api_type
32 33 34 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/local_session_store.rb', line 32 def self.j_api_type @@j_api_type end |
+ (Object) j_class
35 36 37 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/local_session_store.rb', line 35 def self.j_class Java::IoVertxExtWebSstore::LocalSessionStore.java_class end |
+ (Object) unwrap(obj)
29 30 31 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/local_session_store.rb', line 29 def @@j_api_type.unwrap(obj) obj.j_del end |
+ (Object) wrap(obj)
26 27 28 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/local_session_store.rb', line 26 def @@j_api_type.wrap(obj) LocalSessionStore.new(obj) end |
Instance Method Details
- (void) clear { ... }
This method returns an undefined value.
Remove all sessions from the store
93 94 95 96 97 98 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/local_session_store.rb', line 93 def clear if block_given? return @j_del.java_method(:clear, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) })) end raise ArgumentError, "Invalid arguments when calling clear()" end |
- (void) close
This method returns an undefined value.
Close the store
110 111 112 113 114 115 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/local_session_store.rb', line 110 def close if !block_given? return @j_del.java_method(:close, []).call() end raise ArgumentError, "Invalid arguments when calling close()" end |
- (::VertxWeb::Session) create_session(timeout = nil, length = nil)
Create a new session
52 53 54 55 56 57 58 59 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/local_session_store.rb', line 52 def create_session(timeout=nil,length=nil) if timeout.class == Fixnum && !block_given? && length == nil return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:createSession, [Java::long.java_class]).call(timeout),::VertxWeb::Session) elsif timeout.class == Fixnum && length.class == Fixnum && !block_given? return ::Vertx::Util::Utils.safe_create(@j_del.java_method(:createSession, [Java::long.java_class,Java::int.java_class]).call(timeout,length),::VertxWeb::Session) end raise ArgumentError, "Invalid arguments when calling create_session(#{timeout},#{length})" end |
- (void) delete(id = nil) { ... }
This method returns an undefined value.
Delete the session with the specified ID
74 75 76 77 78 79 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/local_session_store.rb', line 74 def delete(id=nil) if id.class == String && block_given? return @j_del.java_method(:delete, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(id,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) })) end raise ArgumentError, "Invalid arguments when calling delete(#{id})" end |
- (void) get(id = nil) { ... }
This method returns an undefined value.
Get the session with the specified ID
64 65 66 67 68 69 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/local_session_store.rb', line 64 def get(id=nil) if id.class == String && block_given? return @j_del.java_method(:get, [Java::java.lang.String.java_class,Java::IoVertxCore::Handler.java_class]).call(id,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ::Vertx::Util::Utils.safe_create(ar.result,::VertxWeb::Session) : nil) })) end raise ArgumentError, "Invalid arguments when calling get(#{id})" end |
- (void) put(session = nil) { ... }
This method returns an undefined value.
Add a session with the specified ID
84 85 86 87 88 89 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/local_session_store.rb', line 84 def put(session=nil) if session.class.method_defined?(:j_del) && block_given? return @j_del.java_method(:put, [Java::IoVertxExtWeb::Session.java_class,Java::IoVertxCore::Handler.java_class]).call(session.j_del,(Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) })) end raise ArgumentError, "Invalid arguments when calling put(#{session})" end |
- (Fixnum) retry_timeout
The retry timeout value in milli seconds used by the session handler when it retrieves a value from the store.
A non positive value means there is no retry at all.
42 43 44 45 46 47 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/local_session_store.rb', line 42 def retry_timeout if !block_given? return @j_del.java_method(:retryTimeout, []).call() end raise ArgumentError, "Invalid arguments when calling retry_timeout()" end |
- (void) size { ... }
This method returns an undefined value.
Get the number of sessions in the store
102 103 104 105 106 107 |
# File '/Users/julien/java/vertx-stack/stack-docs/target/rb/vertx-web/local_session_store.rb', line 102 def size if block_given? return @j_del.java_method(:size, [Java::IoVertxCore::Handler.java_class]).call((Proc.new { |ar| yield(ar.failed ? ar.cause : nil, ar.succeeded ? ar.result : nil) })) end raise ArgumentError, "Invalid arguments when calling size()" end |