class: sslServerSocket

[375:14] (extern: com.lehman.aussom.AussomSslServerSocket) extends: object

The sslServerSocket class implements SSL server socket functionality.

Methods

• sslServerSocket (int Port = 443, string KeyStoreFileName = "", string KeyStorePassword = "")

  Constructor creates a new sslServerSocket object with the optional arguments.

  • @p Port is an int with the port number to bind to.
  • @p KeyStoreFileName is a string with the keystore file to use.
  • @p KeyStorePassword is a string with the keystore password to use.
  • @r This object.

• newSslServerSocket (int Port = 443, string KeyStoreFileName = "", string KeyStorePassword = "")

• bind (string Host = "localhost")

  Binds the socket to a local interface with the provided host name.

  • @p Host is the host to bind to.
  • @r This object.

• close ()

  Closes the server socket.

  • @r This object.

• setReuseAddress (bool ReuseAddress)

  Sets the reuse address flag.

  • @p ReuseAddress is a bool with the flag value.
  • @r This object.

• setPerformancePreferences (int ConnectionTime, int Latency, int Bandwidth)

  Sets the performance preferences. There are no max values here, they are just compared to each other.

  • @p ConnectionTime is an int with the connection time value.
  • @p Latency is an int with the latency value.
  • @p Bandwidth is an int with the bandwidth value.
  • @r This object.

• setReceiveBufferSize (int RxBufferSize)

  Sets the receive buffer size.

  • @p RxBufferSize is an int with the recieve buffer size.
  • @r This object.

• setHost (string Host)

  Sets the host name. Must be called prior to connect.

  • @p Host is a string with the host name to set.
  • @r This object.

• setPort (int Port)

  Sets the port number. Must be called prior to connect.

  • @p Port is an int with the port number to set.
  • @r This object.

• setSoTimeout (int Timeout)

  Sets the SO_TIMEOUT value in milliseconds. Must be called prior to connect.

  • @p Timeout is an int with the timeout to set.
  • @r This object.

• setCiphers (list Ciphers)

  Sets the list of ciphers to use.

  • @p Ciphers is a list of ciphers to use.
  • @r This object.

• setProtocols (list Protocols)

  Sets the list of protocols to use.

  • @p Protocols is a list of protocols.
  • @r This object.

• setEnableSessionCreation (bool Val)

  Sets the enable session creation flag.

  • @p Val is a bool with the flag to set.
  • @r This object.

• setNeedClientAuth (bool Val)

  Sets the need client auth flag.

  • @p Val is a bool with the flag to set.
  • @r This object.

• setUseClientMode (bool Val)

  Sets the use client mode flag.

  • @p Val is a bool with the flag to set.
  • @r This object.

• setWantClientAuth (bool Val)

  Sets the want client auth flag.

  • @p Val is a bool with the flag to set.
  • @r This object.

• accept ()

  Accepts a new connection and returns the socket. This may throw an IO excpetion if interrupted.

  • @r A sslSocket object.

• getHost ()

  Gets the host.

  • @r A string with the host.

• getPort ()

  Gets the port number.

  • @r An int with the port number.

• getReuseAddress ()

  Gets the reuse address flag.

  • @r A bool with the reuse address flag.

• isBound ()

  Gets the is bound status.

  • @r A bool with the is bound status.

• isClosed ()

  Gets the is closed status.

  • @r A bool with the is closed status.

• getReceiveBufferSize ()

  Gets the receive buffer size.

  • @r An int with the receive buffer size.

• getSoTimeout ()

  Gets the SO_TIMEOUT in milliseconds value. Must be called prior to connect.

  • @r An int with the timeout milliseconds.

• getCiphers ()

  Gets a list of the ciphers. Must be called prior to connect.

  • @r A list with the ciphers.

• getProtocols ()

  Gets a list of protocols. Must be called prior to connect.

  • @r A list of protocols.

• getEnableSessionCreation ()

  Gets the enable session creation flag.

  • @r A bool with the flag value.

• getNeedClientAuth ()

  Gets the need client auth flag.

  • @r A bool with the flag value.

• getUseClientMode ()

  Gets the use client mode flag.

  • @r A bool with the flag value.

• getWantClientAuth ()

  Gets the want client auth flag.

  • @r A bool with the flag value.

class: trafficClass

[32:6] static extends: object

Enum for sslSocket traffic classes.

Members

• lowcost
• reliability
• throughput
• lowdelay

class: sslsocket_module

[23:14] static extends: object

Module JAR loader class.

Methods

• sslsocket_module ()

class: sslSocket

[42:14] (extern: com.lehman.aussom.AussomSslSocket) extends: object

The sslSocket class implements SSL socket support.

Methods

• sslSocket (string Host = "", string Port = 443, bool AllowSelfSigned = false)

  The constructor that takes defaulted arguments.

  • @p Host is an optional string with the host.
  • @p Port is an optional int with the port number.
  • @p AllowSelfSigned is an optional bool with the allow self signed flag.
  • @r This object.

• newSslSocket (string Host = "", int Port = 443, bool AllowSelfSigned = false)

• connect (string Host = "")

  Connects to the socket to the server with the provided host.

  • @p Host is a string with the host to connect to.
  • @r This object.

• bind (string Host = "localhost")

  Binds the socket to a local address.

  • @p Host is the local address to bind to.
  • @r This object.

• close ()

  Closes the socket.

  • @r This object.

• setKeepAlive (bool KeepAlive)

  Sets the keep alive flag.

  • @p KeepAlive is a bool with the keep alive flag.
  • @r This object.

• setOOBInline (bool OOBInline)

  Sets the SO_OOBINLINE (receipt of TCP urgent data) flag.

  • @p OOBInline is a bool with the flag.
  • @r This object.

• setPerformancePreferences (int ConnectionTime, int Latency, int Bandwidth)

  Sets the performance preferences. The values don't have a max, instead they are compared to each other.

  • @p ConnectionTime is an int with the connection time value.
  • @p Latency is an int with the latency value.
  • @p Bandwidth is an int with the bandwidth value.
  • @r This object.

• setReceiveBufferSize (int RxBufferSize)

  Sets the receive buffer size.

  • @p RxBufferSize is an int with the receive buffer size.
  • @r This object.

• setReuseAddress (bool ReuseAddress)

  Sets the reuse address flag.

  • @p ReuseAddress is a bool with the reuse address flag.
  • @r This object.

• setSendBufferSize (int TxBufferSize)

  Sets the send buffer size.

  • @p TxBufferSize is an int with the send buffer size.
  • @r This object.

• setSoLinger (bool LingerOn, int LingerVal)

  Sets the flag and the SO_LINGER val with the specified linger time in seconds.

  • @p LingerOn is a bool with the flag.
  • @p LingerVal is an int with the value.
  • @r This object.

• setTcpNoDelay (bool NoDelay)

  Sets the TCP no delay flag.

  • @p NoDelay is a bool with the flag.
  • @r This object.

• setTrafficClass (string TrafficClass)

  Sets the traffic class. See the trafficClass enum for available options.

  • @p TrafficClass is a string with the traffic class to set.
  • @r This object.

• writeln (string Line)

  Writes the provided line to the socket.

  • @p Line is a string with the line to write.
  • @r This object.

• write (string Str)

  Writes the provided string to the socket.

  • @p Str is a string to write.
  • @r This object.

• writeBytes (object Buff)

  Writes the bytes in the provided Buffer to the socket.

  • @p Buff is a Buffer object to write.
  • @r This object.

• writeBytesFrom (object Buff, int Index = 0, int Length = -1)

  Writes bytes from the provided Buffer with the provided optional index and length.

  • @p Buff is a Buffer with the bytes to write.
  • @p Index is an int with the index to write from.
  • @p Length is an int with the number of bytes to write.
  • @r This object.

• setHost (string Host)

  Sets the host with the provided string. Must be called prior to connect.

  • @p Host is a string with the host value.
  • @r This object.

• setPort (int Port)

  Sets the socket port. Must be called prior to connect.

  • @p Port is an int with the port number to set.
  • @r This object.

• setSoTimeout (int Timeout)

  Sets the SO_TIMEOUT value in milliseconds. Must be called prior to connect.

  • @p Timeout is an int with the value.
  • @r This object.

• setCiphers (list Ciphers)

  Sets the list of ciphers.

  • @p Ciphers is a list of ciphers to use.
  • @r This object.

• setProtocols (list Protocols)

  Sets a list of all the enabled protocols.

  • @p Protocols is a list of protocols to use.
  • @r This object.

• setEnableSessionCreation (bool Val)

  Sets the enable session creation flag.

  • @p Val is a bool with the flag value.
  • @r This object.

• setNeedClientAuth (bool Val)

  Sets the needs client auth flag.

  • @p Val is a bool with the flag value.
  • @r This object.

• setUseClientMode (bool Val)

  Sets the use client mode flag.

  • @p Val is a bool with the flag value.
  • @r This object.

• setWantClientAuth (bool Val)

  Sets the want client auth flag.

  • @p Val is a bool with the flag value.
  • @r This object.

• startHandshake ()

  Starts the SSL handshake.

  • @r This object.

• readln ()

  Reads a line from the socket and returns it.

  • @r A string with the line read.

• read ()

  Reads a character from the socket and returns it.

  • @r A string with the read character.

• readBytes (int Length)

  Reads X number of bytes from the stream into a Buffer that is returned.

  • @p Length is an int with the number of bytes to read.
  • @r A Buffer object with the read bytes.

• readBytesTo (object Buff, int Index = 0, int Length = -1)

  Reads X number of bytes from the stream into the provided Buffer at the given index.

  • @p Buff is the Buffer object to read into.
  • @p Index is an int with the start index to read into.
  • @p Length is an int with the length in bytes to read.
  • @r This object.

• getKeepAlive ()

  Gets the keep alive flag.

  • @r A bool with the keep alive flag.

• getOOBInline ()

  Gets the SO_OOBINLINE (receipt of TCP urgent data) flag.

  • @r A bool with the flag value.

• getReceiveBufferSize ()

  Gets the receive buffer size.

  • @r An int with the receive buffer size.

• getReuseAddress ()

  Gets the reuse address flag.

  • @r A bool with the flag.

• getSendBufferSize ()

  Gets the send buffer size.

  • @r An int with the send buffer size.

• getSoLinger ()

  Gets the SO_LINGER value.

  • @r An int with the value.

• getTcpNoDelay ()

  Gets the TCP no delay flag value.

  • @r A bool with the flag value.

• getTrafficClass ()

  Gets the traffic class for the sslSocket. See the trafficClass enum for available values.

  • @r A string with the socket class.

• getSoTimeout ()

  Gets the SO_TIMEOUT value in milliseconds. Must be called prior to connect.

  • @r An int with the value.

• getCiphers ()

  Gets the ciphers list.

  • @r A list with the ciphers.

• getProtocols ()

  Gets the protocols list.

  • @r A list with the protocols.

• getEnableSessionCreation ()

  Gets the enable session creation flag.

  • @r A bool with the flag value.

• getNeedClientAuth ()

  Gets the need client auth flag.

  • @r A bool with the flag value.

• getUseClientMode ()

  Gets the use client mode flag.

  • @r A bool with the flag value.

• getWantClientAuth ()

  Gets the want client auth flag.

  • @r A bool with the flag value.