ProxySession (Atomix API Reference (3.0.0-rc4))

```
public interface ProxySession<S>
```
Proxy session.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CompletableFuture<Void>`	`accept(Consumer<S> operation)` Submits an empty operation to the given partition.
`void`	`addStateChangeListener(Consumer<PrimitiveState> listener)` Registers a session state change listener.
`<R> CompletableFuture<R>`	`apply(Function<S,R> operation)` Submits an empty operation to the given partition.
`CompletableFuture<Void>`	`close()` Closes the proxy session.
`CompletableFuture<ProxySession<S>>`	`connect()` Connects the proxy session.
`io.atomix.utils.concurrent.ThreadContext`	`context()` Returns the session thread context.
`PrimitiveState`	`getState()` Returns the session state.
`String`	`name()` Returns the primitive name.
`void`	`register(Object client)` Registers a client listener.
`void`	`removeStateChangeListener(Consumer<PrimitiveState> listener)` Removes a state change listener.
`PrimitiveType`	`type()` Returns the client proxy type.

- Method Detail
  - name
```
String name()
```
    Returns the primitive name.
    
    Returns:
    
    the primitive name
  - type
```
PrimitiveType type()
```
    Returns the client proxy type.
    
    Returns:
    
    The client proxy type.
  - context
```
io.atomix.utils.concurrent.ThreadContext context()
```
    Returns the session thread context.
    
    Returns:
    
    the session thread context
  - getState
```
PrimitiveState getState()
```
    Returns the session state.
    
    Returns:
    
    The session state.
  - register
```
void register(Object client)
```
    Registers a client listener.
    
    Parameters:
    
    client - the client listener to register
  - accept
```
CompletableFuture<Void> accept(Consumer<S> operation)
```
    Submits an empty operation to the given partition.
    
    Parameters:
    
    operation - the operation identifier
    
    Returns:
    
    A completable future to be completed with the operation result. The future is guaranteed to be completed after all PrimitiveOperation submission futures that preceded it.
    
    Throws:
    
    NullPointerException - if operation is null
  - apply
```
<R> CompletableFuture<R> apply(Function<S,R> operation)
```
    Submits an empty operation to the given partition.
    
    Type Parameters:
    
    R - the operation result type
    
    Parameters:
    
    operation - the operation identifier
    
    Returns:
    
    A completable future to be completed with the operation result. The future is guaranteed to be completed after all PrimitiveOperation submission futures that preceded it.
    
    Throws:
    
    NullPointerException - if operation is null
  - addStateChangeListener
```
void addStateChangeListener(Consumer<PrimitiveState> listener)
```
    Registers a session state change listener.
    
    Parameters:
    
    listener - The callback to call when the session state changes.
  - removeStateChangeListener
```
void removeStateChangeListener(Consumer<PrimitiveState> listener)
```
    Removes a state change listener.
    
    Parameters:
    
    listener - the state change listener to remove
  - connect
```
CompletableFuture<ProxySession<S>> connect()
```
    Connects the proxy session.
    
    Returns:
    
    a future to be completed once the proxy session has been connected
  - close
```
CompletableFuture<Void> close()
```
    Closes the proxy session.
    
    Returns:
    
    a future to be completed once the proxy session has been closed

Interface ProxySession<S>

Method Summary

Method Detail

name

type

context

getState

register

accept

apply

addStateChangeListener

removeStateChangeListener

connect

close