tech.ydb.coordination

Interface CoordinationSession

All Known Implementing Classes:

CoordinationSessionImpl

public interface CoordinationSession

Author:

Kirill Kurdyukov

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	CoordinationSession.Observer

Method Summary

Modifier and Type	Method and Description
long	getSessionId()
void	sendAcquireSemaphore(tech.ydb.proto.coordination.SessionRequest.AcquireSemaphore acquireSemaphore) Used to acquire a semaphore
void	sendCreateSemaphore(tech.ydb.proto.coordination.SessionRequest.CreateSemaphore createSemaphore) Used to create a new semaphore
void	sendDeleteSemaphore(tech.ydb.proto.coordination.SessionRequest.DeleteSemaphore deleteSemaphore) Used to delete an existing semaphore
void	sendDescribeSemaphore(tech.ydb.proto.coordination.SessionRequest.DescribeSemaphore describeSemaphore) Used to describe semaphores and watch them for changes
void	sendPingPong(tech.ydb.proto.coordination.SessionRequest.PingPong pingPong) Used for checking liveness of the connection
void	sendReleaseSemaphore(tech.ydb.proto.coordination.SessionRequest.ReleaseSemaphore releaseSemaphore) Used to release a semaphore
void	sendStartSession(tech.ydb.proto.coordination.SessionRequest.SessionStart sessionStart) First message used to start/restore a session
void	sendUpdateSemaphore(tech.ydb.proto.coordination.SessionRequest.UpdateSemaphore updateSemaphore) Used to change semaphore data
CompletableFuture<Status>	start(CoordinationSession.Observer observer)
void	stop()

Method Detail

getSessionId

long getSessionId()

start

CompletableFuture<Status> start(CoordinationSession.Observer observer)

sendStartSession

void sendStartSession(tech.ydb.proto.coordination.SessionRequest.SessionStart sessionStart)

First message used to start/restore a session

Parameters:

sessionStart - session start of proto body

sendPingPong

void sendPingPong(tech.ydb.proto.coordination.SessionRequest.PingPong pingPong)

Used for checking liveness of the connection

Parameters:

pingPong - ping pong of proto body

sendAcquireSemaphore

void sendAcquireSemaphore(tech.ydb.proto.coordination.SessionRequest.AcquireSemaphore acquireSemaphore)

Used to acquire a semaphore

WARNING: a single session cannot acquire the same semaphore multiple times

Later requests override previous operations with the same semaphore, e.g. to reduce acquired count, change timeout or attached data.

Parameters:

acquireSemaphore - acquire semaphore of proto body

sendReleaseSemaphore

void sendReleaseSemaphore(tech.ydb.proto.coordination.SessionRequest.ReleaseSemaphore releaseSemaphore)

Used to release a semaphore

WARNING: a single session cannot release the same semaphore multiple times

The release operation will either remove current session from waiters queue or release an already owned semaphore.

Parameters:

releaseSemaphore - release semaphore of proto body

sendDescribeSemaphore

void sendDescribeSemaphore(tech.ydb.proto.coordination.SessionRequest.DescribeSemaphore describeSemaphore)

Used to describe semaphores and watch them for changes

WARNING: a describe operation will cancel previous watches on the same semaphore

Parameters:

describeSemaphore - describe semaphore of proto body

sendCreateSemaphore

void sendCreateSemaphore(tech.ydb.proto.coordination.SessionRequest.CreateSemaphore createSemaphore)

Used to create a new semaphore

Parameters:

createSemaphore - create semaphore of proto body

sendUpdateSemaphore

void sendUpdateSemaphore(tech.ydb.proto.coordination.SessionRequest.UpdateSemaphore updateSemaphore)

Used to change semaphore data

Parameters:

updateSemaphore - update semaphore of proto body

sendDeleteSemaphore

void sendDeleteSemaphore(tech.ydb.proto.coordination.SessionRequest.DeleteSemaphore deleteSemaphore)

Used to delete an existing semaphore

Parameters:

deleteSemaphore - delete semaphore of proto body

stop

void stop()