SimpleSmfClient (Solace JMS API v10.6.3)

java.lang.Object
- com.solacesystems.jcsmp.protocol.smf.SimpleSmfClient

All Implemented Interfaces:

IOHandler, ReadIOHandler, WriteIOHandler

Direct Known Subclasses:

ZSmfClient
```
public class SimpleSmfClient
extends Object
implements WriteIOHandler, ReadIOHandler
```

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class SimpleSmfClient.PriorityData

static class SimpleSmfClient.SS

Nested Classes
Modifier and Type	Class and Description
`static class`	`SimpleSmfClient.PriorityData`
`static class`	`SimpleSmfClient.SS`

Field Summary

Fields
Modifier and Type	Field and Description
`static int`	`C_CLOSED`
`static int`	`C_CONNECTING`
`static int`	`C_RECON_STARTED`
`static int`	`NOT_CONNECTED`
`static int`	`WRCODE_DROPPED`
`static int`	`WRCODE_OK`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`beginReconnection()` Signal we're beginning reconnection.
`void`	`clearCallbackHandler()`
`void`	`close()`
`void`	`close(boolean isReconn)`
`boolean`	`connected()`
`void`	`deregisterClientRead()`
`void`	`doPost(WireMessage request, WireMessage response, boolean setAuth)`
`void`	`doPostNoResponse(WireMessage request, boolean setAuth)`
`int`	`doSmfSharedWrite(WireMessage request, ByteBuffer[] requestBB, boolean setAuth, boolean setCorrTag, boolean dropOnWouldBlock, boolean allowOnStateSub, boolean allowReactorFinishWrite, boolean stopOnNoconnection)`
`int`	`doSmfSharedWrite(WireMessage request, ByteBuffer[] requestBB, boolean setAuth, boolean setCorrTag, boolean dropOnWouldBlock, boolean allowOnStateSub, boolean allowReactorFinishWrite, Integer idTag, TcpClientChannel channel, ClientRequestResponse req, Long corrId, boolean stopOnNoconnection)` Used by client channel.
`void`	`endPostReconnect()`
`void`	`endReconnection(boolean success, SimpleSmfClient.SS stateOnSuccess, SimpleSmfClient.SS expectedState, int timeout)`
`void`	`enqueuePriorityData(WireMessage wmsg)`
`long`	`getBytesWritten()`
`AbstractSelectableChannel`	`getChannel()`
`int`	`getConnCounter()`
`Integer`	`getConnCounterTag()`
`int`	`getConnTimeout()`
`SeqNumAllocator`	`getCtrl_seqAlloc()`
`JCSMPSecureProtocolSocketFactory`	`getJcsmpSecureProtocolSocketFactory()`
`InetAddress`	`getLocalAddress()`
`int`	`getLocalPort()`
`String`	`getNetworkInfoString()`
`String`	`getRemoteHost()`
`int`	`getRemotePort()`
`SimpleSmfClient.SS`	`getSharedSocketState()`
`int`	`getSmfClientId()`
`int`	`getSO_rcvbuf()`
`int`	`getSO_sndbuf()`
`Socket`	`getSocket()`
`int`	`getSockTimeout()`
`void`	`handleClosedSocketDuringRead(CancelledKeyException cke, SelectableChannel sc)`
`void`	`handleClosedSocketDuringWrite(CancelledKeyException cke, SelectableChannel sc)`
`void`	`incrementConnCounterTag()`
`void`	`initState()`
`boolean`	`isClientConnected()`
`boolean`	`isTcpNoDelay()`
`static int`	`limitBytes(ByteBuffer[] buf_vector)`
`void`	`notifyFatalError(JCSMPFatalErrorException ex)`
`void`	`open()`
`void`	`read()` Perform non-blocking socket read.
`void`	`registerClientRead()`
`static int`	`remainingBytes(ByteBuffer[] buf_vector)`
`void`	`setClientProps(JCSMPChannelProperties cprops)`
`void`	`setConnTimeout(int connTimeout)`
`void`	`setJcsmpSecureProtocolSocketFactory(JCSMPSecureProtocolSocketFactory jcsmpSecureProtocolSocketFactory)`
`void`	`setLocalAddress(InetAddress localAddr)`
`void`	`setRemoteHost(HostInfo host)`
`void`	`setRemotePort(int remotePort)`
`void`	`setSO_rcvbuf(int so_rcvbuf)`
`void`	`setSO_sndbuf(int so_sndbuf)`
`void`	`setSockTimeout(int sockTimeout)`
`void`	`setSubscriberMessageReader(SubscriberMessageReader subReader)`
`void`	`setTcpNoDelay(boolean tcpNoDelay)`
`String`	`toString()`
`void`	`write(SelectableChannel keyChannel)` Perform non-blocking socket write.

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

Field Detail
- WRCODE_OK
```
public static final int WRCODE_OK
```
  See Also:
  
  Constant Field Values
- WRCODE_DROPPED
```
public static final int WRCODE_DROPPED
```
  See Also:
  
  Constant Field Values
- NOT_CONNECTED
```
public static final int NOT_CONNECTED
```
  See Also:
  
  Constant Field Values
- C_CLOSED
```
public static final int C_CLOSED
```
  See Also:
  
  Constant Field Values
- C_CONNECTING
```
public static final int C_CONNECTING
```
  See Also:
  
  Constant Field Values
- C_RECON_STARTED
```
public static final int C_RECON_STARTED
```
  See Also:
  
  Constant Field Values

Method Detail

toString
```
public String toString()
```
Overrides:

toString in class Object

getLocalPort
```
public int getLocalPort()
```

getNetworkInfoString
```
public String getNetworkInfoString()
```

initState
```
public final void initState()
```

getCtrl_seqAlloc

public SeqNumAllocator getCtrl_seqAlloc()

setClientProps

public void setClientProps(JCSMPChannelProperties cprops)

enqueuePriorityData

public void enqueuePriorityData(WireMessage wmsg)

setSubscriberMessageReader

public void setSubscriberMessageReader(SubscriberMessageReader subReader)

doPost

public void doPost(WireMessage request,
                   WireMessage response,
                   boolean setAuth)
            throws JCSMPException,
                   IOException

Throws:: JCSMPException; IOException

doPostNoResponse

public void doPostNoResponse(WireMessage request,
                             boolean setAuth)
                      throws JCSMPException,
                             IOException

Throws:: JCSMPException; IOException

beginReconnection
```
public int beginReconnection()
                      throws InterruptedException
```
Signal we're beginning reconnection. Returns false if another thread has already begun reconnection and this thread should not attempt it.

Returns:

result

Throws:

InterruptedException

endReconnection

public void endReconnection(boolean success,
                            SimpleSmfClient.SS stateOnSuccess,
                            SimpleSmfClient.SS expectedState,
                            int timeout)
                     throws JCSMPTransportException

Throws:: JCSMPTransportException

endPostReconnect
```
public void endPostReconnect()
```

getSharedSocketState

public SimpleSmfClient.SS getSharedSocketState()

doSmfSharedWrite

public int doSmfSharedWrite(WireMessage request,
                            ByteBuffer[] requestBB,
                            boolean setAuth,
                            boolean setCorrTag,
                            boolean dropOnWouldBlock,
                            boolean allowOnStateSub,
                            boolean allowReactorFinishWrite,
                            boolean stopOnNoconnection)
                     throws JCSMPException,
                            IOException,
                            InterruptedException

Throws:: JCSMPException; IOException; InterruptedException

doSmfSharedWrite

public int doSmfSharedWrite(WireMessage request,
                            ByteBuffer[] requestBB,
                            boolean setAuth,
                            boolean setCorrTag,
                            boolean dropOnWouldBlock,
                            boolean allowOnStateSub,
                            boolean allowReactorFinishWrite,
                            Integer idTag,
                            TcpClientChannel channel,
                            ClientRequestResponse req,
                            Long corrId,
                            boolean stopOnNoconnection)
                     throws JCSMPException,
                            IOException,
                            InterruptedException

Used by client channel. A return code of 0 means the write is thought to have worked. Returning 1 means a low-priority request was discarded.

Throws:: JCSMPException; IOException; InterruptedException

remainingBytes

public static int remainingBytes(ByteBuffer[] buf_vector)

limitBytes

public static int limitBytes(ByteBuffer[] buf_vector)

clearCallbackHandler
```
public void clearCallbackHandler()
```
Specified by:

clearCallbackHandler in interface IOHandler

getChannel
```
public AbstractSelectableChannel getChannel()
```
Specified by:

getChannel in interface IOHandler

handleClosedSocketDuringWrite

public void handleClosedSocketDuringWrite(CancelledKeyException cke,
                                          SelectableChannel sc)

Specified by:: handleClosedSocketDuringWrite in interface WriteIOHandler

write
```
public void write(SelectableChannel keyChannel)
```
Description copied from interface: WriteIOHandler

Perform non-blocking socket write. Called by an IOReactor when a SocketChannel is ready to write data.

Specified by:

write in interface WriteIOHandler

connected
```
public boolean connected()
```

isClientConnected
```
public boolean isClientConnected()
```

open

public void open()
          throws UnknownHostException,
                 IOException,
                 JCSMPException

Throws:: UnknownHostException; IOException; JCSMPException

getConnCounter
```
public int getConnCounter()
```

getConnCounterTag
```
public Integer getConnCounterTag()
```

incrementConnCounterTag
```
public void incrementConnCounterTag()
```

getBytesWritten
```
public long getBytesWritten()
```

close

public void close()
           throws IOException

Throws:: IOException

close

public void close(boolean isReconn)
           throws IOException

Throws:: IOException

getSocket
```
public Socket getSocket()
```

getConnTimeout
```
public int getConnTimeout()
```

setConnTimeout

public void setConnTimeout(int connTimeout)

getLocalAddress
```
public InetAddress getLocalAddress()
```

setLocalAddress

public void setLocalAddress(InetAddress localAddr)

getRemoteHost
```
public String getRemoteHost()
```

setRemoteHost

public void setRemoteHost(HostInfo host)

getRemotePort
```
public int getRemotePort()
```

setRemotePort

public void setRemotePort(int remotePort)

getSockTimeout
```
public int getSockTimeout()
```

setSockTimeout

public void setSockTimeout(int sockTimeout)

getSO_sndbuf
```
public int getSO_sndbuf()
```

setSO_sndbuf

public void setSO_sndbuf(int so_sndbuf)

getSO_rcvbuf
```
public int getSO_rcvbuf()
```

setSO_rcvbuf

public void setSO_rcvbuf(int so_rcvbuf)

getJcsmpSecureProtocolSocketFactory

public JCSMPSecureProtocolSocketFactory getJcsmpSecureProtocolSocketFactory()

setJcsmpSecureProtocolSocketFactory

public void setJcsmpSecureProtocolSocketFactory(JCSMPSecureProtocolSocketFactory jcsmpSecureProtocolSocketFactory)

isTcpNoDelay
```
public boolean isTcpNoDelay()
```

setTcpNoDelay

public void setTcpNoDelay(boolean tcpNoDelay)

handleClosedSocketDuringRead

public void handleClosedSocketDuringRead(CancelledKeyException cke,
                                         SelectableChannel sc)

Specified by:: handleClosedSocketDuringRead in interface ReadIOHandler

read
```
public void read()
```
Description copied from interface: ReadIOHandler

Perform non-blocking socket read. Called by an IOReactor when a SocketChannel is ready to read data.

Specified by:

read in interface ReadIOHandler

registerClientRead
```
public void registerClientRead()
```

deregisterClientRead
```
public void deregisterClientRead()
```

getSmfClientId
```
public int getSmfClientId()
```

notifyFatalError
```
public void notifyFatalError(JCSMPFatalErrorException ex)
```
Specified by:

notifyFatalError in interface IOHandler

Class SimpleSmfClient

Nested Class Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

WRCODE_OK

WRCODE_DROPPED

NOT_CONNECTED

C_CLOSED

C_CONNECTING

C_RECON_STARTED

Method Detail

toString

getLocalPort

getNetworkInfoString

initState

getCtrl_seqAlloc

setClientProps

enqueuePriorityData

setSubscriberMessageReader

doPost

doPostNoResponse

beginReconnection

endReconnection

endPostReconnect

getSharedSocketState

doSmfSharedWrite

doSmfSharedWrite

remainingBytes

limitBytes

clearCallbackHandler

getChannel

handleClosedSocketDuringWrite

write

connected

isClientConnected

open

getConnCounter

getConnCounterTag

incrementConnCounterTag

getBytesWritten

close

close

getSocket

getConnTimeout

setConnTimeout

getLocalAddress

setLocalAddress

getRemoteHost

setRemoteHost

getRemotePort

setRemotePort

getSockTimeout

setSockTimeout

getSO_sndbuf

setSO_sndbuf

getSO_rcvbuf

setSO_rcvbuf

getJcsmpSecureProtocolSocketFactory

setJcsmpSecureProtocolSocketFactory

isTcpNoDelay

setTcpNoDelay

handleClosedSocketDuringRead

read

registerClientRead

deregisterClientRead

getSmfClientId

notifyFatalError