Package org.redisson
Class RedissonBinaryStream
- java.lang.Object
-
- org.redisson.RedissonObject
-
- org.redisson.RedissonBucket<byte[]>
-
- org.redisson.RedissonBinaryStream
-
- All Implemented Interfaces:
RBinaryStream
,RBucket<byte[]>
,RBucketAsync<byte[]>
,RExpirable
,RExpirableAsync
,RObject
,RObjectAsync
public class RedissonBinaryStream extends RedissonBucket<byte[]> implements RBinaryStream
- Author:
- Nikita Koksharov
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
RedissonBinaryStream.RedissonAsynchronousByteChannel
-
Field Summary
-
Fields inherited from class org.redisson.RedissonObject
codec, commandExecutor, name
-
-
Constructor Summary
Constructors Modifier Constructor Description protected
RedissonBinaryStream(CommandAsyncExecutor connectionManager, String name)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
clearExpire()
Clear an expire timeout or expire date for object.RFuture<Boolean>
clearExpireAsync()
Clear an expire timeout or expire date for object in async mode.protected RFuture<Boolean>
clearExpireAsync(String... keys)
boolean
expire(long timeToLive, TimeUnit timeUnit)
UseRExpirable.expire(Duration)
insteadboolean
expire(Duration duration)
Sets a timeout for this object.boolean
expire(Instant instant)
Sets an expiration date for this object.RFuture<Boolean>
expireAsync(long timeToLive, TimeUnit timeUnit)
UseRExpirableAsync.expireAsync(Duration)
insteadprotected RFuture<Boolean>
expireAsync(long timeToLive, TimeUnit timeUnit, String param, String... keys)
RFuture<Boolean>
expireAsync(Duration duration)
Set a timeout for object.RFuture<Boolean>
expireAsync(Instant instant)
Set an expire date for object.boolean
expireAt(long timestamp)
UseRExpirable.expire(Instant)
insteadboolean
expireAt(Date timestamp)
UseRExpirable.expire(Instant)
insteadRFuture<Boolean>
expireAtAsync(long timestamp)
UseRExpirableAsync.expireAsync(Instant)
insteadprotected RFuture<Boolean>
expireAtAsync(long timestamp, String param, String... keys)
RFuture<Boolean>
expireAtAsync(Date timestamp)
UseRExpirableAsync.expireAsync(Instant)
insteadboolean
expireIfGreater(Duration duration)
Sets a timeout for this object only if it's greater than timeout set before.boolean
expireIfGreater(Instant time)
Sets an expiration date for this object only if it's greater than expiration date set before.RFuture<Boolean>
expireIfGreaterAsync(Duration duration)
RFuture<Boolean>
expireIfGreaterAsync(Instant time)
boolean
expireIfLess(Duration duration)
Sets a timeout for this object only if it's less than timeout set before.boolean
expireIfLess(Instant time)
Sets an expiration date for this object only if it's less than expiration date set before.RFuture<Boolean>
expireIfLessAsync(Duration duration)
RFuture<Boolean>
expireIfLessAsync(Instant time)
boolean
expireIfNotSet(Duration duration)
Sets a timeout for this object only if it hasn't been set before.boolean
expireIfNotSet(Instant time)
Sets an expiration date for this object only if it hasn't been set before.RFuture<Boolean>
expireIfNotSetAsync(Duration duration)
RFuture<Boolean>
expireIfNotSetAsync(Instant time)
boolean
expireIfSet(Duration duration)
Sets a timeout for this object only if it has been already set.boolean
expireIfSet(Instant time)
Sets an expiration date for this object only if it has been already set.RFuture<Boolean>
expireIfSetAsync(Duration duration)
RFuture<Boolean>
expireIfSetAsync(Instant time)
AsynchronousByteChannel
getAsynchronousChannel()
Returns async channel object which allows to write and read binary stream.SeekableByteChannel
getChannel()
Returns channel object which allows to write and read binary stream.long
getExpireTime()
Expiration time of Redisson object that has a timeoutRFuture<Long>
getExpireTimeAsync()
Expiration time of Redisson object that has a timeoutInputStream
getInputStream()
Returns inputStream object which allows to read binary stream.OutputStream
getOutputStream()
Returns outputStream object which allows to write binary stream.long
remainTimeToLive()
Remaining time to live of Redisson object that has a timeoutRFuture<Long>
remainTimeToLiveAsync()
Remaining time to live of Redisson object that has a timeout-
Methods inherited from class org.redisson.RedissonBucket
addListener, addListenerAsync, compareAndSet, compareAndSetAsync, get, getAndClearExpire, getAndClearExpireAsync, getAndDelete, getAndDeleteAsync, getAndExpire, getAndExpire, getAndExpireAsync, getAndExpireAsync, getAndSet, getAndSet, getAndSetAsync, getAndSetAsync, getAsync, removeListener, removeListenerAsync, set, set, setAndKeepTTL, setAndKeepTTLAsync, setAsync, setAsync, setIfExists, setIfExists, setIfExistsAsync, setIfExistsAsync, size, sizeAsync, trySet, trySet, trySetAsync, trySetAsync
-
Methods inherited from class org.redisson.RedissonObject
addListener, addListenerAsync, copy, copyAsync, delete, deleteAsync, deleteAsync, dump, dumpAsync, encode, encode, encode, encode, encodeMapKey, encodeMapKeys, encodeMapValue, encodeMapValues, get, getCodec, getIdleTime, getIdleTimeAsync, getLockByMapKey, getLockByValue, getName, getRawName, getRawName, isExists, isExistsAsync, migrate, migrateAsync, move, moveAsync, prefixName, rename, renameAsync, renamenx, renamenxAsync, restore, restore, restoreAndReplace, restoreAndReplace, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, setName, sizeInMemory, sizeInMemoryAsync, sizeInMemoryAsync, sizeInMemoryAsync, suffixName, toSeconds, toStream, touch, touchAsync, unlink, unlinkAsync
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
-
Methods inherited from interface org.redisson.api.RBucket
addListener, compareAndSet, get, getAndClearExpire, getAndDelete, getAndExpire, getAndExpire, getAndSet, getAndSet, set, set, setAndKeepTTL, setIfExists, setIfExists, size, trySet, trySet
-
Methods inherited from interface org.redisson.api.RBucketAsync
addListenerAsync, compareAndSetAsync, getAndClearExpireAsync, getAndDeleteAsync, getAndExpireAsync, getAndExpireAsync, getAndSetAsync, getAndSetAsync, getAsync, setAndKeepTTLAsync, setAsync, setAsync, setIfExistsAsync, setIfExistsAsync, sizeAsync, trySetAsync, trySetAsync
-
Methods inherited from interface org.redisson.api.RExpirable
clearExpire, expire, expire, expire, expireAt, expireAt, expireIfGreater, expireIfGreater, expireIfLess, expireIfLess, expireIfNotSet, expireIfNotSet, expireIfSet, expireIfSet, getExpireTime, remainTimeToLive
-
Methods inherited from interface org.redisson.api.RExpirableAsync
clearExpireAsync, expireAsync, expireAsync, expireAsync, expireAtAsync, expireAtAsync, expireIfGreaterAsync, expireIfGreaterAsync, expireIfLessAsync, expireIfLessAsync, expireIfNotSetAsync, expireIfNotSetAsync, expireIfSetAsync, expireIfSetAsync, getExpireTimeAsync, remainTimeToLiveAsync
-
Methods inherited from interface org.redisson.api.RObject
copy, delete, dump, getCodec, getIdleTime, getName, isExists, migrate, move, removeListener, rename, renamenx, restore, restore, restoreAndReplace, restoreAndReplace, sizeInMemory, touch, unlink
-
Methods inherited from interface org.redisson.api.RObjectAsync
copyAsync, deleteAsync, dumpAsync, getIdleTimeAsync, isExistsAsync, migrateAsync, moveAsync, removeListenerAsync, renameAsync, renamenxAsync, restoreAndReplaceAsync, restoreAndReplaceAsync, restoreAsync, restoreAsync, sizeInMemoryAsync, touchAsync, unlinkAsync
-
-
-
-
Constructor Detail
-
RedissonBinaryStream
protected RedissonBinaryStream(CommandAsyncExecutor connectionManager, String name)
-
-
Method Detail
-
getInputStream
public InputStream getInputStream()
Description copied from interface:RBinaryStream
Returns inputStream object which allows to read binary stream. This object isn't thread-safe.- Specified by:
getInputStream
in interfaceRBinaryStream
- Returns:
- stream object
-
getOutputStream
public OutputStream getOutputStream()
Description copied from interface:RBinaryStream
Returns outputStream object which allows to write binary stream. This object isn't thread-safe.- Specified by:
getOutputStream
in interfaceRBinaryStream
- Returns:
- stream object
-
getChannel
public SeekableByteChannel getChannel()
Description copied from interface:RBinaryStream
Returns channel object which allows to write and read binary stream. This object isn't thread-safe.- Specified by:
getChannel
in interfaceRBinaryStream
- Returns:
- channel object
-
getAsynchronousChannel
public AsynchronousByteChannel getAsynchronousChannel()
Description copied from interface:RBinaryStream
Returns async channel object which allows to write and read binary stream. This object isn't thread-safe.- Specified by:
getAsynchronousChannel
in interfaceRBinaryStream
- Returns:
- channel object
-
expire
public boolean expire(long timeToLive, TimeUnit timeUnit)
Description copied from interface:RExpirable
UseRExpirable.expire(Duration)
instead- Specified by:
expire
in interfaceRExpirable
- Parameters:
timeToLive
- - timeout before object will be deletedtimeUnit
- - timeout time unit- Returns:
true
if the timeout was set andfalse
if not
-
expireAsync
public RFuture<Boolean> expireAsync(long timeToLive, TimeUnit timeUnit)
Description copied from interface:RExpirableAsync
UseRExpirableAsync.expireAsync(Duration)
instead- Specified by:
expireAsync
in interfaceRExpirableAsync
- Parameters:
timeToLive
- - timeout before object will be deletedtimeUnit
- - timeout time unit- Returns:
true
if the timeout was set andfalse
if not
-
expireAt
public boolean expireAt(long timestamp)
Description copied from interface:RExpirable
UseRExpirable.expire(Instant)
instead- Specified by:
expireAt
in interfaceRExpirable
- Parameters:
timestamp
- - expire date in milliseconds (Unix timestamp)- Returns:
true
if the timeout was set andfalse
if not
-
expireAtAsync
public RFuture<Boolean> expireAtAsync(long timestamp)
Description copied from interface:RExpirableAsync
UseRExpirableAsync.expireAsync(Instant)
instead- Specified by:
expireAtAsync
in interfaceRExpirableAsync
- Parameters:
timestamp
- - expire date in milliseconds (Unix timestamp)- Returns:
true
if the timeout was set andfalse
if not
-
expire
public boolean expire(Instant instant)
Description copied from interface:RExpirable
Sets an expiration date for this object. When expire date comes the key will automatically be deleted.- Specified by:
expire
in interfaceRExpirable
- Parameters:
instant
- expire date- Returns:
true
if the timeout was set andfalse
if not
-
expireIfSet
public boolean expireIfSet(Instant time)
Description copied from interface:RExpirable
Sets an expiration date for this object only if it has been already set. When expire date comes the object will automatically be deleted.Requires Redis 7.0.0 and higher.
- Specified by:
expireIfSet
in interfaceRExpirable
- Parameters:
time
- expire date- Returns:
true
if the timeout was set andfalse
if not
-
expireIfSetAsync
public RFuture<Boolean> expireIfSetAsync(Instant time)
- Specified by:
expireIfSetAsync
in interfaceRExpirableAsync
-
expireIfNotSet
public boolean expireIfNotSet(Instant time)
Description copied from interface:RExpirable
Sets an expiration date for this object only if it hasn't been set before. When expire date comes the object will automatically be deleted.Requires Redis 7.0.0 and higher.
- Specified by:
expireIfNotSet
in interfaceRExpirable
- Parameters:
time
- expire date- Returns:
true
if the timeout was set andfalse
if not
-
expireIfNotSetAsync
public RFuture<Boolean> expireIfNotSetAsync(Instant time)
- Specified by:
expireIfNotSetAsync
in interfaceRExpirableAsync
-
expireIfGreater
public boolean expireIfGreater(Instant time)
Description copied from interface:RExpirable
Sets an expiration date for this object only if it's greater than expiration date set before. When expire date comes the object will automatically be deleted.Requires Redis 7.0.0 and higher.
- Specified by:
expireIfGreater
in interfaceRExpirable
- Parameters:
time
- expire date- Returns:
true
if the timeout was set andfalse
if not
-
expireIfGreaterAsync
public RFuture<Boolean> expireIfGreaterAsync(Instant time)
- Specified by:
expireIfGreaterAsync
in interfaceRExpirableAsync
-
expireIfLess
public boolean expireIfLess(Instant time)
Description copied from interface:RExpirable
Sets an expiration date for this object only if it's less than expiration date set before. When expire date comes the object will automatically be deleted.Requires Redis 7.0.0 and higher.
- Specified by:
expireIfLess
in interfaceRExpirable
- Parameters:
time
- expire date- Returns:
true
if the timeout was set andfalse
if not
-
expireIfLessAsync
public RFuture<Boolean> expireIfLessAsync(Instant time)
- Specified by:
expireIfLessAsync
in interfaceRExpirableAsync
-
expireAsync
public RFuture<Boolean> expireAsync(Instant instant)
Description copied from interface:RExpirableAsync
Set an expire date for object. When expire date comes the key will automatically be deleted.- Specified by:
expireAsync
in interfaceRExpirableAsync
- Parameters:
instant
- - expire date- Returns:
true
if the timeout was set andfalse
if not
-
expire
public boolean expire(Duration duration)
Description copied from interface:RExpirable
Sets a timeout for this object. After the timeout has expired, the key will automatically be deleted.- Specified by:
expire
in interfaceRExpirable
- Parameters:
duration
- timeout before object will be deleted- Returns:
true
if the timeout was set andfalse
if not
-
expireAsync
public RFuture<Boolean> expireAsync(Duration duration)
Description copied from interface:RExpirableAsync
Set a timeout for object. After the timeout has expired, the key will automatically be deleted.- Specified by:
expireAsync
in interfaceRExpirableAsync
- Parameters:
duration
- timeout before object will be deleted- Returns:
true
if the timeout was set andfalse
if not
-
expireAt
public boolean expireAt(Date timestamp)
Description copied from interface:RExpirable
UseRExpirable.expire(Instant)
instead- Specified by:
expireAt
in interfaceRExpirable
- Parameters:
timestamp
- - expire date- Returns:
true
if the timeout was set andfalse
if not
-
expireAtAsync
public RFuture<Boolean> expireAtAsync(Date timestamp)
Description copied from interface:RExpirableAsync
UseRExpirableAsync.expireAsync(Instant)
instead- Specified by:
expireAtAsync
in interfaceRExpirableAsync
- Parameters:
timestamp
- - expire date- Returns:
true
if the timeout was set andfalse
if not
-
expireIfSet
public boolean expireIfSet(Duration duration)
Description copied from interface:RExpirable
Sets a timeout for this object only if it has been already set. After the timeout has expired, the key will automatically be deleted.Requires Redis 7.0.0 and higher.
- Specified by:
expireIfSet
in interfaceRExpirable
- Parameters:
duration
- timeout before object will be deleted- Returns:
true
if the timeout was set andfalse
if not
-
expireIfSetAsync
public RFuture<Boolean> expireIfSetAsync(Duration duration)
- Specified by:
expireIfSetAsync
in interfaceRExpirableAsync
-
expireIfNotSet
public boolean expireIfNotSet(Duration duration)
Description copied from interface:RExpirable
Sets a timeout for this object only if it hasn't been set before. After the timeout has expired, the key will automatically be deleted.Requires Redis 7.0.0 and higher.
- Specified by:
expireIfNotSet
in interfaceRExpirable
- Parameters:
duration
- timeout before object will be deleted- Returns:
true
if the timeout was set andfalse
if not
-
expireIfNotSetAsync
public RFuture<Boolean> expireIfNotSetAsync(Duration duration)
- Specified by:
expireIfNotSetAsync
in interfaceRExpirableAsync
-
expireIfGreater
public boolean expireIfGreater(Duration duration)
Description copied from interface:RExpirable
Sets a timeout for this object only if it's greater than timeout set before. After the timeout has expired, the key will automatically be deleted.Requires Redis 7.0.0 and higher.
- Specified by:
expireIfGreater
in interfaceRExpirable
- Parameters:
duration
- timeout before object will be deleted- Returns:
true
if the timeout was set andfalse
if not
-
expireIfGreaterAsync
public RFuture<Boolean> expireIfGreaterAsync(Duration duration)
- Specified by:
expireIfGreaterAsync
in interfaceRExpirableAsync
-
expireIfLess
public boolean expireIfLess(Duration duration)
Description copied from interface:RExpirable
Sets a timeout for this object only if it's less than timeout set before. After the timeout has expired, the key will automatically be deleted.Requires Redis 7.0.0 and higher.
- Specified by:
expireIfLess
in interfaceRExpirable
- Parameters:
duration
- timeout before object will be deleted- Returns:
true
if the timeout was set andfalse
if not
-
expireIfLessAsync
public RFuture<Boolean> expireIfLessAsync(Duration duration)
- Specified by:
expireIfLessAsync
in interfaceRExpirableAsync
-
clearExpire
public boolean clearExpire()
Description copied from interface:RExpirable
Clear an expire timeout or expire date for object.- Specified by:
clearExpire
in interfaceRExpirable
- Returns:
true
if timeout was removedfalse
if object does not exist or does not have an associated timeout
-
clearExpireAsync
public RFuture<Boolean> clearExpireAsync()
Description copied from interface:RExpirableAsync
Clear an expire timeout or expire date for object in async mode. Object will not be deleted.- Specified by:
clearExpireAsync
in interfaceRExpirableAsync
- Returns:
true
if the timeout was cleared andfalse
if not
-
remainTimeToLive
public long remainTimeToLive()
Description copied from interface:RExpirable
Remaining time to live of Redisson object that has a timeout- Specified by:
remainTimeToLive
in interfaceRExpirable
- Returns:
- time in milliseconds -2 if the key does not exist. -1 if the key exists but has no associated expire.
-
remainTimeToLiveAsync
public RFuture<Long> remainTimeToLiveAsync()
Description copied from interface:RExpirableAsync
Remaining time to live of Redisson object that has a timeout- Specified by:
remainTimeToLiveAsync
in interfaceRExpirableAsync
- Returns:
- time in milliseconds -2 if the key does not exist. -1 if the key exists but has no associated expire.
-
getExpireTime
public long getExpireTime()
Description copied from interface:RExpirable
Expiration time of Redisson object that has a timeoutRequires Redis 7.0.0 and higher.
- Specified by:
getExpireTime
in interfaceRExpirable
- Returns:
- expiration time
-
getExpireTimeAsync
public RFuture<Long> getExpireTimeAsync()
Description copied from interface:RExpirableAsync
Expiration time of Redisson object that has a timeoutRequires Redis 7.0.0 and higher.
- Specified by:
getExpireTimeAsync
in interfaceRExpirableAsync
- Returns:
- expiration time
-
expireAsync
protected RFuture<Boolean> expireAsync(long timeToLive, TimeUnit timeUnit, String param, String... keys)
-
expireAtAsync
protected RFuture<Boolean> expireAtAsync(long timestamp, String param, String... keys)
-
-