reactor.spring.messaging.factory.net

Class NetServerFactoryBean

java.lang.Object

reactor.spring.messaging.factory.net.NetServerFactoryBean

All Implemented Interfaces:

org.springframework.beans.factory.FactoryBean<reactor.net.NetServer>, org.springframework.context.Lifecycle, org.springframework.context.Phased, org.springframework.context.SmartLifecycle

public class NetServerFactoryBean
extends java.lang.Object
implements org.springframework.beans.factory.FactoryBean<reactor.net.NetServer>, org.springframework.context.SmartLifecycle

FactoryBean for creating a Reactor NetServer.

Constructor Summary

Constructors

Constructor and Description
NetServerFactoryBean(reactor.core.Environment env)

Method Summary

Methods

Modifier and Type	Method and Description
reactor.net.NetServer	getObject()
java.lang.Class<?>	getObjectType()
int	getPhase()
boolean	isAutoStartup()
boolean	isRunning()
boolean	isSingleton()
NetServerFactoryBean	setAutoStartup(boolean autoStartup) Set whether to perform auto startup.
NetServerFactoryBean	setCodec(java.lang.String codec) Set the Codec to use to managing encoding and decoding of the data.
NetServerFactoryBean	setDelimiter(java.lang.String delimiter) Set the single-byte delimiter to use when framing is set to 'delimited'.
NetServerFactoryBean	setDispatcher(java.lang.String dispatcher) Set the name of the Dispatcher to use, which will be pulled from the current Environment.
NetServerFactoryBean	setFraming(java.lang.String framing) Set the type of framing to use.
NetServerFactoryBean	setHost(java.lang.String host) Set the host to which this server will bind.
NetServerFactoryBean	setLengthFieldLength(int lengthFieldLength) Set the length of the length field if using length-field framing.
NetServerFactoryBean	setMessageHandler(org.springframework.messaging.MessageHandler messageHandler) Set the MessageHandler that will handle each incoming message.
NetServerFactoryBean	setPhase(int phase) Set the phase in which this bean should start.
NetServerFactoryBean	setPort(int port) Set the port to which this server will bind.
NetServerFactoryBean	setTransport(java.lang.String transport) Set the transport to use for this NetServer.
void	start()
void	stop()
void	stop(java.lang.Runnable callback)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NetServerFactoryBean

public NetServerFactoryBean(reactor.core.Environment env)

Method Detail

setDispatcher

public NetServerFactoryBean setDispatcher(java.lang.String dispatcher)

Set the name of the Dispatcher to use, which will be pulled from the current Environment.

Parameters:

dispatcher - dispatcher name

Returns:

this

setPhase

public NetServerFactoryBean setPhase(int phase)

Set the phase in which this bean should start.

Parameters:

phase - the phase

Returns:

this

setAutoStartup

public NetServerFactoryBean setAutoStartup(boolean autoStartup)

Set whether to perform auto startup.

Parameters:

autoStartup - true to enable auto startup, false otherwise

Returns:

this

setHost

public NetServerFactoryBean setHost(java.lang.String host)

Set the host to which this server will bind.

Parameters:

host - the host to bind to (defaults to 0.0.0.0)

Returns:

this

setPort

public NetServerFactoryBean setPort(int port)

Set the port to which this server will bind.

Parameters:

port - the port to bind to (defaults to 3000)

Returns:

this

setCodec

public NetServerFactoryBean setCodec(java.lang.String codec)

Set the Codec to use to managing encoding and decoding of the data.

The options for codecs currently are:

• bytes - Use the standard byte array codec.
• string - Use the standard String codec.
• syslog - Use the standard Syslog codec.

Parameters:

codec - the codec

Returns:

this

setFraming

public NetServerFactoryBean setFraming(java.lang.String framing)

Set the type of framing to use.

The options for framing are:

• delimited - Means use a delimited line codec (defaults to LF).
• length - Means use a length-field based codec where the initial bytes of a message are the length of the rest of the message.

Parameters:

framing - type of framing

Returns:

this

setDelimiter

public NetServerFactoryBean setDelimiter(java.lang.String delimiter)

Set the single-byte delimiter to use when framing is set to 'delimited'. The options for delimiters are:

• LF - Means use a line feed \\n.
• CR - Means use a carriage return \\r.

Parameters:

delimiter - the delimiter to use

setLengthFieldLength

public NetServerFactoryBean setLengthFieldLength(int lengthFieldLength)

Set the length of the length field if using length-field framing.

Parameters:

lengthFieldLength - 2 for a short, 4 for an int (the default), or 8 for a long

Returns:

this

setTransport

public NetServerFactoryBean setTransport(java.lang.String transport)

Set the transport to use for this NetServer.

Options for transport currently are:

• tcp - Use the built-in Netty TCP support.
• udp - Use the built-in Netty UDP support.

Parameters:

transport - the transport to use

Returns:

this

setMessageHandler

public NetServerFactoryBean setMessageHandler(org.springframework.messaging.MessageHandler messageHandler)

Set the MessageHandler that will handle each incoming message.

Parameters:

messageHandler - the MessageHandler to use

isAutoStartup

public boolean isAutoStartup()

Specified by:

isAutoStartup in interface org.springframework.context.SmartLifecycle

stop

public void stop(java.lang.Runnable callback)

Specified by:

stop in interface org.springframework.context.SmartLifecycle

start

public void start()

Specified by:

start in interface org.springframework.context.Lifecycle

stop

public void stop()

Specified by:

stop in interface org.springframework.context.Lifecycle

isRunning

public boolean isRunning()

Specified by:

isRunning in interface org.springframework.context.Lifecycle

getPhase

public int getPhase()

Specified by:

getPhase in interface org.springframework.context.Phased

getObject

public reactor.net.NetServer getObject()
                                throws java.lang.Exception

Specified by:

getObject in interface org.springframework.beans.factory.FactoryBean<reactor.net.NetServer>

Throws:

java.lang.Exception

getObjectType

public java.lang.Class<?> getObjectType()

Specified by:

getObjectType in interface org.springframework.beans.factory.FactoryBean<reactor.net.NetServer>

isSingleton

public boolean isSingleton()

Specified by:

isSingleton in interface org.springframework.beans.factory.FactoryBean<reactor.net.NetServer>