NettyRSocketServerFactory (spring-boot 2.2.12.RELEASE)

java.lang.Object
- org.springframework.boot.rsocket.netty.NettyRSocketServerFactory

All Implemented Interfaces:

ConfigurableRSocketServerFactory, RSocketServerFactory
```
public class NettyRSocketServerFactory
extends Object
implements RSocketServerFactory, ConfigurableRSocketServerFactory
```
RSocketServerFactory that can be used to create RSocketServers backed by Netty.

Since:

2.2.0

Author:

Brian Clozel

Constructor Summary

Constructors
Constructor and Description

NettyRSocketServerFactory()

Constructors
Constructor and Description
`NettyRSocketServerFactory()`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addRSocketServerCustomizers(RSocketServerCustomizer... rSocketServerCustomizers)` Add `RSocketServerCustomizer`s that should be called to configure the `RSocketServer`.
`void`	`addSocketFactoryProcessors(ServerRSocketFactoryProcessor... socketFactoryProcessors)` Deprecated. in favor of `addRSocketServerCustomizers(RSocketServerCustomizer...)` as of 2.2.7
`NettyRSocketServer`	`create(io.rsocket.SocketAcceptor socketAcceptor)` Gets a new fully configured but paused `RSocketServer` instance.
`void`	`setAddress(InetAddress address)` Set the specific network address that the server should bind to.
`void`	`setLifecycleTimeout(Duration lifecycleTimeout)` Set the maximum amount of time that should be waited when starting or stopping the server.
`void`	`setPort(int port)` Set the port that the server should listen on.
`void`	`setResourceFactory(org.springframework.http.client.reactive.ReactorResourceFactory resourceFactory)` Set the `ReactorResourceFactory` to get the shared resources from.
`void`	`setRSocketServerCustomizers(Collection<? extends RSocketServerCustomizer> rSocketServerCustomizers)` Set `RSocketServerCustomizer`s that should be called to configure the `RSocketServer` while building the server.
`void`	`setSocketFactoryProcessors(Collection<? extends ServerRSocketFactoryProcessor> socketFactoryProcessors)` Deprecated. in favor of `setRSocketServerCustomizers(Collection)` as of 2.2.7
`void`	`setTransport(RSocketServer.Transport transport)` Set the transport that the RSocket server should use.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - NettyRSocketServerFactory
```
public NettyRSocketServerFactory()
```
- Method Detail
  - setPort
```
public void setPort(int port)
```
    Description copied from interface: ConfigurableRSocketServerFactory
    
    Set the port that the server should listen on. If not specified port '9898' will be used.
    
    Specified by:
    
    setPort in interface ConfigurableRSocketServerFactory
    
    Parameters:
    
    port - the port to set
  - setAddress
```
public void setAddress(InetAddress address)
```
    Description copied from interface: ConfigurableRSocketServerFactory
    
    Set the specific network address that the server should bind to.
    
    Specified by:
    
    setAddress in interface ConfigurableRSocketServerFactory
    
    Parameters:
    
    address - the address to set (defaults to null)
  - setTransport
```
public void setTransport(RSocketServer.Transport transport)
```
    Description copied from interface: ConfigurableRSocketServerFactory
    
    Set the transport that the RSocket server should use.
    
    Specified by:
    
    setTransport in interface ConfigurableRSocketServerFactory
    
    Parameters:
    
    transport - the transport protocol to use
  - setResourceFactory
```
public void setResourceFactory(org.springframework.http.client.reactive.ReactorResourceFactory resourceFactory)
```
    Set the ReactorResourceFactory to get the shared resources from.
    
    Parameters:
    
    resourceFactory - the server resources
  - setSocketFactoryProcessors
```
@Deprecated
public void setSocketFactoryProcessors(Collection<? extends ServerRSocketFactoryProcessor> socketFactoryProcessors)
```
    Deprecated. in favor of setRSocketServerCustomizers(Collection) as of 2.2.7
    
    Set ServerRSocketFactoryProcessors that should be called to process the RSocketFactory.ServerRSocketFactory while building the server. Calling this method will replace any existing processors.
    
    Parameters:
    
    socketFactoryProcessors - processors to apply before the server starts
  - addSocketFactoryProcessors
```
@Deprecated
public void addSocketFactoryProcessors(ServerRSocketFactoryProcessor... socketFactoryProcessors)
```
    Deprecated. in favor of addRSocketServerCustomizers(RSocketServerCustomizer...) as of 2.2.7
    
    Add ServerRSocketFactoryProcessors that should be called to process the RSocketFactory.ServerRSocketFactory while building the server.
    
    Parameters:
    
    socketFactoryProcessors - processors to apply before the server starts
  - setRSocketServerCustomizers
```
public void setRSocketServerCustomizers(Collection<? extends RSocketServerCustomizer> rSocketServerCustomizers)
```
    Set RSocketServerCustomizers that should be called to configure the RSocketServer while building the server. Calling this method will replace any existing customizers.
    
    Parameters:
    
    rSocketServerCustomizers - customizers to apply before the server starts
    
    Since:
    
    2.2.7
  - addRSocketServerCustomizers
```
public void addRSocketServerCustomizers(RSocketServerCustomizer... rSocketServerCustomizers)
```
    Add RSocketServerCustomizers that should be called to configure the RSocketServer.
    
    Parameters:
    
    rSocketServerCustomizers - customizers to apply before the server starts
    
    Since:
    
    2.2.7
  - setLifecycleTimeout
```
public void setLifecycleTimeout(Duration lifecycleTimeout)
```
    Set the maximum amount of time that should be waited when starting or stopping the server.
    
    Parameters:
    
    lifecycleTimeout - the lifecycle timeout
  - create
```
public NettyRSocketServer create(io.rsocket.SocketAcceptor socketAcceptor)
```
    Description copied from interface: RSocketServerFactory
    
    Gets a new fully configured but paused RSocketServer instance. Clients should not be able to connect to the returned server until RSocketServer.start() is called (which happens when the ApplicationContext has been fully refreshed).
    
    Specified by:
    
    create in interface RSocketServerFactory
    
    Parameters:
    
    socketAcceptor - the socket acceptor
    
    Returns:
    
    a fully configured and started RSocketServer
    
    See Also:
    
    RSocketServer.stop()

Class NettyRSocketServerFactory

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NettyRSocketServerFactory

Method Detail

setPort

setAddress

setTransport

setResourceFactory

setSocketFactoryProcessors

addSocketFactoryProcessors

setRSocketServerCustomizers

addRSocketServerCustomizers

setLifecycleTimeout

create