SSLServer Module

Properties   Methods   Events   Config Settings   Errors  

The SSLServer Module is a generic Transmission Control Protocol (TCP) server module based on an asynchronous, event-driven architecture. It is designed to balance the load between connections for a fast, powerful server.

Syntax

IPWorksSSL.Sslserver

Remarks

The SSLServer Class supports Secure Sockets Layer/Transport Layer Security (SSL/TLS) connections. When connecting over SSL/TLS the SSLServerAuthentication event allows you to check the server identity and other security attributes. The SSLStatus event provides information about the SSL handshake. Additional SSL related settings are also supported via the Config method. The SSLCert properties are used to select a certificate for the server. Note: A valid certificate MUST be selected before the server can function.

SSLServer is the server complement of SSLClient, which is used to create client applications. They share a common design philosophy and interface. We expect you will find SSLServer as easy to use as SSLClient.

By default, each instance of SSLServer can handle up to 1,000 simultaneous incoming connections. This number may be increased up to 100,000 or decreased to a lower value by using the MaxConnections configuration setting.

The connections are identified by a ConnectionId, an Id generated by the component to identify each connection. This Id is unique to each connection. SSLServer's events also have ConnectionId as a parameter to identify the connection they relate to.

Our main goal in designing SSLServer was to make it easy to use without sacrificing performance. The class has a minimum of properties, and six events: ConnectionRequest, Connected, DataIn, Disconnected, ReadyToSend, and Error.

SSLServer can start to listen on a port by setting the Listening property to True. When a remote host asks for a connection, the ConnectionRequest event is fired. At that point, the connection can either be accepted or rejected. If the connection is accepted, a ConnectionId is assigned, and communication can start. From this point on, the operation is very similar to SSLClient. Data are sent by assigning the data string to the DataToSend property. The address and port of the incoming connection can be found by querying the RemoteHost and RemotePort properties.

Note: Server components are designed to process events as they occur. To ensure that events are processed in a timely manner, DoEvents should be called in a loop after the server is started.

Property List

The following is the full list of the properties of the module with short descriptions. Click on the links for further details.

Method List

The following is the full list of the methods of the module with short descriptions. Click on the links for further details.

Event List

The following is the full list of the events fired by the module with short descriptions. Click on the links for further details.

Config Settings

The following is a list of config settings for the module with short descriptions. Click on the links for further details.

ConnectionBacklog Property (SSLServer Module)

This property includes the maximum number of pending connections maintained by the Transmission Control Protocol (TCP)/IP subsystem.

Syntax

• Swift
• Objective-C

public var connectionBacklog: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=connectionBacklog,setter=setConnectionBacklog:) int connectionBacklog;

- (int)connectionBacklog;
- (void)setConnectionBacklog :(int)newConnectionBacklog;

Default Value

5

Remarks

This property contains the maximum number of pending connections maintained by the TCP/IP subsystem. This value reflects the SOMAXCONN option for the main listening socket. The default value for most systems is 5. You may set this property to a larger value if the server is expected to receive a large number of connections, and queuing them is desirable.

Connections Property (SSLServer Module)

This property includes a collection of currently connected clients.

Syntax

• Swift
• Objective-C

public var connections: [String: Connection] {
  get {...}
}

@property (nonatomic,readonly,assign,getter=connectionCount) int connectionCount;

- (int)connectionCount;

- (BOOL)acceptData:(int)connectionId;
- (void)setAcceptData:(int)connectionId :(BOOL)newAcceptData;

- (int)bytesSent:(int)connectionId;

- (BOOL)connected:(int)connectionId;
- (void)setConnected:(int)connectionId :(BOOL)newConnected;

- (NSString*)connectionId:(int)connectionId;

- (NSString*)dataToSend:(int)connectionId;
- (void)setDataToSend:(int)connectionId :(NSString*)newDataToSend;

- (NSData*)dataToSendB:(int)connectionId;
- (void)setDataToSendB:(int)connectionId :(NSData*)newDataToSend;
- (NSString*)EOL:(int)connectionId;
- (void)setEOL:(int)connectionId :(NSString*)newEOL;

- (NSData*)EOLB:(int)connectionId;
- (void)setEOLB:(int)connectionId :(NSData*)newEOL;
- (int)idleTimeout:(int)connectionId;
- (void)setIdleTimeout:(int)connectionId :(int)newIdleTimeout;

- (NSString*)localAddress:(int)connectionId;

- (BOOL)readyToSend:(int)connectionId;

- (int)recordLength:(int)connectionId;
- (void)setRecordLength:(int)connectionId :(int)newRecordLength;

- (NSString*)remoteHost:(int)connectionId;

- (int)remotePort:(int)connectionId;

- (BOOL)singleLineMode:(int)connectionId;
- (void)setSingleLineMode:(int)connectionId :(BOOL)newSingleLineMode;

- (int)timeout:(int)connectionId;
- (void)setTimeout:(int)connectionId :(int)newTimeout;

- (NSString*)userData:(int)connectionId;
- (void)setUserData:(int)connectionId :(NSString*)newUserData;

- (NSData*)userDataB:(int)connectionId;
- (void)setUserDataB:(int)connectionId :(NSData*)newUserData;

Default Value

0

Remarks

This property contains a collection of currently connected clients. All of the connections may be managed using this property. Each connection is described by the different fields of the Connection type.

This collection is a hash-table type of collection, in which the Connection Id string is used as the key to the desired connection. You may acquire the key for a given connection through the Connected event.

Example (Broadcasting Data) For i = 0 to Control.ConnectionCount Control.DataToSend(Control.ConnectionId(i)) = "Broadcast Data" Next i

DefaultEOL Property (SSLServer Module)

This property includes a default end-of-line (EOL) value to be used by incoming connections.

Syntax

• Swift
• Objective-C

public var defaultEOL: String {
  get {...}
  set {...}
}

public var defaultEOLB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=defaultEOL,setter=setDefaultEOL:) NSString* defaultEOL;

- (NSString*)defaultEOL;
- (void)setDefaultEOL :(NSString*)newDefaultEOL;

@property (nonatomic,readwrite,assign,getter=defaultEOLB,setter=setDefaultEOLB:) NSData* defaultEOLB;

- (NSData*)defaultEOLB;
- (void)setDefaultEOLB :(NSData*)newDefaultEOL;

Default Value

""

Remarks

This property contains a default end-of-line (EOL) value to be used by incoming connections. Once the class accepts and establishes an inbound connection, it will set that connection's EOL to the value in this property. By default, this value is empty (""), meaning that data will be fired as it is received.

DefaultIdleTimeout Property (SSLServer Module)

This property includes the default idle timeout for inactive clients.

Syntax

• Swift
• Objective-C

public var defaultIdleTimeout: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=defaultIdleTimeout,setter=setDefaultIdleTimeout:) int defaultIdleTimeout;

- (int)defaultIdleTimeout;
- (void)setDefaultIdleTimeout :(int)newDefaultIdleTimeout;

Default Value

0

Remarks

This property specifies the idle timeout (in seconds) for clients. When set to a positive value, the class will disconnect idle clients after the specified timeout.

This applies only to clients that have not sent or received data within DefaultIdleTimeout seconds.

If set to 0 (default), no idle timeout is applied.

Note: DoEvents must be called for the class to check existing connections.

DefaultMaxLineLength Property (SSLServer Module)

The property includes the default maximum line length value for inbound connections.

Syntax

• Swift
• Objective-C

public var defaultMaxLineLength: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=defaultMaxLineLength,setter=setDefaultMaxLineLength:) int defaultMaxLineLength;

- (int)defaultMaxLineLength;
- (void)setDefaultMaxLineLength :(int)newDefaultMaxLineLength;

Default Value

2048

Remarks

This property controls the default size of an internal buffer that holds received data while waiting for an end-of-line (EOL) string.

The minimum value for this property is 256 bytes. The default value is 2048 bytes.

DefaultSingleLineMode Property (SSLServer Module)

This property tells the module whether or not to treat new connections as line oriented.

Syntax

• Swift
• Objective-C

public var defaultSingleLineMode: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=defaultSingleLineMode,setter=setDefaultSingleLineMode:) BOOL defaultSingleLineMode;

- (BOOL)defaultSingleLineMode;
- (void)setDefaultSingleLineMode :(BOOL)newDefaultSingleLineMode;

Default Value

False

Remarks

This property instructs the component whether or not to treat newly established connections as line-oriented protocols. If this value is True, newly accepted connections will read the incoming data stream as lines separated by a carriage return line feed (CRLF), carriage return (CR), or line feed (LF) and will ignore the end of lines (EOLs).

DefaultTimeout Property (SSLServer Module)

This property includes an initial timeout value to be used by incoming connections.

Syntax

• Swift
• Objective-C

public var defaultTimeout: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=defaultTimeout,setter=setDefaultTimeout:) int defaultTimeout;

- (int)defaultTimeout;
- (void)setDefaultTimeout :(int)newDefaultTimeout;

Default Value

0

Remarks

This property is used by the class to set the operational timeout value of all inbound connections once they are established.

By default, the timeout is 0, meaning that all inbound connections will behave asynchronously.

KeepAlive Property (SSLServer Module)

When True, KEEPALIVE packets are enabled (for long connections).

Syntax

• Swift
• Objective-C

public var keepAlive: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=keepAlive,setter=setKeepAlive:) BOOL keepAlive;

- (BOOL)keepAlive;
- (void)setKeepAlive :(BOOL)newKeepAlive;

Default Value

False

Remarks

This property enables the SO_KEEPALIVE option on the incoming connections. This option prevents long connections from timing out in case of inactivity.

Note: System Transmission Control Protocol (TCP)/IP stack implementations are not required to support SO_KEEPALIVE.

This property is shared among incoming connections. When the property is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified.

Linger Property (SSLServer Module)

When set to True, connections are terminated gracefully.

Syntax

• Swift
• Objective-C

public var linger: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=linger,setter=setLinger:) BOOL linger;

- (BOOL)linger;
- (void)setLinger :(BOOL)newLinger;

Default Value

True

Remarks

This property controls how a connection is closed. The default is True. In this case, the connection is closed only after all the data are sent. Setting it to False forces an abrupt (hard) disconnection. Any data that were in the sending queue may be lost.

The default behavior (which is also the default mode for stream sockets) might result in an indefinite delay in closing the connection. Although the class returns control immediately, the system might indefinitely hold system resources until all pending data are sent (even after your application closes). This means that valuable system resources might be wasted.

Setting this property to False forces an immediate disconnection. If you know that the other side has received all the data you have sent (e.g., by a client acknowledgment), then setting this property to False might be the appropriate course of action.

This property is shared among incoming connections. When the property is set, the corresponding value is set for incoming connections as they are accepted. Existing connections are not modified.

Listening Property (SSLServer Module)

If set to True, the module accepts incoming connections on LocalPort.

Syntax

• Swift
• Objective-C

public var listening: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=listening,setter=setListening:) BOOL listening;

- (BOOL)listening;
- (void)setListening :(BOOL)newListening;

Default Value

False

Remarks

This property indicates whether the class is listening for connections on the port specified by the LocalPort property.

Note: Use the StartListening and StopListening methods to control whether the class is listening.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setListening(listening: Bool) throws

LocalHost Property (SSLServer Module)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Syntax

• Swift
• Objective-C

public var localHost: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=localHost,setter=setLocalHost:) NSString* localHost;

- (NSString*)localHost;
- (void)setLocalHost :(NSString*)newLocalHost;

Default Value

""

Remarks

The LocalHost property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multi-homed hosts (machines with more than one IP interface).

NOTE: LocalHost is not persistent. You must always set it in code, and never in the property window.

LocalPort Property (SSLServer Module)

This property includes the Transmission Control Protocol (TCP) port in the local host where the module listens.

Syntax

• Swift
• Objective-C

public var localPort: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=localPort,setter=setLocalPort:) int localPort;

- (int)localPort;
- (void)setLocalPort :(int)newLocalPort;

Default Value

0

Remarks

This property must be set before the class can start listening. If its value is 0, then the TCP/IP subsystem picks a port number at random. The port number can be found by checking the value of this property after the class is listening (i.e., after successfully assigning True to the Listening property).

The service port is not shared among servers so two classs cannot be listening on the same port at the same time.

SSLAuthenticateClients Property (SSLServer Module)

If set to True, the server asks the client(s) for a certificate.

Syntax

• Swift
• Objective-C

public var sslAuthenticateClients: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLAuthenticateClients,setter=setSSLAuthenticateClients:) BOOL SSLAuthenticateClients;

- (BOOL)SSLAuthenticateClients;
- (void)setSSLAuthenticateClients :(BOOL)newSSLAuthenticateClients;

Default Value

False

Remarks

This property is used in conjunction with the SSLClientAuthentication event. Please refer to the documentation of the SSLClientAuthentication event for details.

SSLCertEncoded Property (SSLServer Module)

This is the certificate (PEM/base64 encoded).

Syntax

• Swift
• Objective-C

public var sslCertEncoded: String {
  get {...}
  set {...}
}

public var sslCertEncodedB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertEncoded,setter=setSSLCertEncoded:) NSString* SSLCertEncoded;

- (NSString*)SSLCertEncoded;
- (void)setSSLCertEncoded :(NSString*)newSSLCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSLCertEncodedB,setter=setSSLCertEncodedB:) NSData* SSLCertEncodedB;

- (NSData*)SSLCertEncodedB;
- (void)setSSLCertEncodedB :(NSData*)newSSLCertEncoded;

Default Value

""

Remarks

This is the certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLCertEncodedB(sslCertEncoded: Data) throws
public func setSSLCertEncoded(sslCertEncoded: String) throws

SSLCertStore Property (SSLServer Module)

This is the name of the certificate store for the client certificate.

Syntax

• Swift
• Objective-C

public var sslCertStore: String {
  get {...}
  set {...}
}

public var sslCertStoreB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertStore,setter=setSSLCertStore:) NSString* SSLCertStore;

- (NSString*)SSLCertStore;
- (void)setSSLCertStore :(NSString*)newSSLCertStore;

@property (nonatomic,readwrite,assign,getter=SSLCertStoreB,setter=setSSLCertStoreB:) NSData* SSLCertStoreB;

- (NSData*)SSLCertStoreB;
- (void)setSSLCertStoreB :(NSData*)newSSLCertStore;

Default Value

"MY"

Remarks

This is the name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

SSLCertStorePassword Property (SSLServer Module)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Syntax

• Swift
• Objective-C

public var sslCertStorePassword: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertStorePassword,setter=setSSLCertStorePassword:) NSString* SSLCertStorePassword;

- (NSString*)SSLCertStorePassword;
- (void)setSSLCertStorePassword :(NSString*)newSSLCertStorePassword;

Default Value

""

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

SSLCertStoreType Property (SSLServer Module)

This is the type of certificate store for this certificate.

Syntax

• Swift
• Objective-C

public var sslCertStoreType: SslserverSSLCertStoreTypes {
  get {...}
  set {...}
}

public enum SslserverSSLCertStoreTypes: Int32 {
  case cstUser = 0
  case cstMachine = 1
  case cstPFXFile = 2
  case cstPFXBlob = 3
  case cstJKSFile = 4
  case cstJKSBlob = 5
  case cstPEMKeyFile = 6
  case cstPEMKeyBlob = 7
  case cstPublicKeyFile = 8
  case cstPublicKeyBlob = 9
  case cstSSHPublicKeyBlob = 10
  case cstP7BFile = 11
  case cstP7BBlob = 12
  case cstSSHPublicKeyFile = 13
  case cstPPKFile = 14
  case cstPPKBlob = 15
  case cstXMLFile = 16
  case cstXMLBlob = 17
  case cstJWKFile = 18
  case cstJWKBlob = 19
  case cstSecurityKey = 20
  case cstBCFKSFile = 21
  case cstBCFKSBlob = 22
  case cstPKCS11 = 23
  case cstAuto = 99
}

@property (nonatomic,readwrite,assign,getter=SSLCertStoreType,setter=setSSLCertStoreType:) int SSLCertStoreType;

- (int)SSLCertStoreType;
- (void)setSSLCertStoreType :(int)newSSLCertStoreType;

Default Value

0

Remarks

This is the type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

SSLCertSubject Property (SSLServer Module)

This is the subject of the certificate used for client authentication.

Syntax

• Swift
• Objective-C

public var sslCertSubject: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertSubject,setter=setSSLCertSubject:) NSString* SSLCertSubject;

- (NSString*)SSLCertSubject;
- (void)setSSLCertSubject :(NSString*)newSSLCertSubject;

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setSSLCertSubject(sslCertSubject: String) throws

SSLProvider Property (SSLServer Module)

This specifies the SSL/TLS implementation to use.

Syntax

• Swift
• Objective-C

public var sslProvider: SslserverSSLProviders {
  get {...}
  set {...}
}

public enum SslserverSSLProviders: Int32 {
  case sslpAutomatic = 0
  case sslpPlatform = 1
  case sslpInternal = 2
}

@property (nonatomic,readwrite,assign,getter=SSLProvider,setter=setSSLProvider:) int SSLProvider;

- (int)SSLProvider;
- (void)setSSLProvider :(int)newSSLProvider;

Default Value

0

Remarks

This property specifies the SSL/TLS implementation to use. In most cases the default value of 0 (Automatic) is recommended and should not be changed. When set to 0 (Automatic) the class will select whether to use the platform implementation or the internal implementation depending on the operating system as well as the TLS version being used.

Possible values are:

In most cases using the default value (Automatic) is recommended. The class will select a provider depending on the current platform.

When Automatic is selected the platform implementation will be used by default in all cases in the macOS edition.

ChangeRecordLength Method (SSLServer Module)

This method changes the length of received data records.

Syntax

• Swift
• Objective-C

public func changeRecordLength(connectionId: Int32, recordLength: Int32) throws -> Void

- (void)changeRecordLength:(int)connectionId :(int)recordLength;

Remarks

This method defines the length of data records to be received (in bytes) for the specified ConnectionId.

If RecordLength is set to a positive value, the class will accumulate data until RecordLength bytes of data are received and only then will fire the DataIn event with data of the specified length RecordLength. This allows data to be received as records of known length. This method can be called at any time to change the record length, including within the DataIn event.

A value of 0 (default) means this functionality is not used.

Config Method (SSLServer Module)

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)configurationString;

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Disconnect Method (SSLServer Module)

This method disconnects the specified client.

Syntax

• Swift
• Objective-C

public func disconnect(connectionId: Int32) throws -> Void

- (void)disconnect:(int)connectionId;

Remarks

Calling this method will disconnect the client specified by the ConnectionId parameter.

DoEvents Method (SSLServer Module)

Processes events from the internal message queue.

Syntax

• Swift
• Objective-C

public func doEvents() throws -> Void

- (void)doEvents;

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

Interrupt Method (SSLServer Module)

This method interrupts a synchronous send to the remote host.

Syntax

• Swift
• Objective-C

public func interrupt(connectionId: Int32) throws -> Void

- (void)interrupt:(int)connectionId;

Remarks

This property is called using the Connection Id if you wish to interrupt a connection and stop a file from uploading without disconnecting the client connected to the class. If you use SendFile to upload a file, the class will run synchronously on that Connection Id until it is completed.

PauseData Method (SSLServer Module)

This method pauses data reception.

Syntax

• Swift
• Objective-C

public func pauseData(connectionId: Int32) throws -> Void

- (void)pauseData:(int)connectionId;

Remarks

This method pauses data reception for the connection identified by ConnectionId when called. While data reception is paused, the DataIn event will not fire for the specified connection. Call ProcessData to reenable data reception.

ProcessData Method (SSLServer Module)

This method reenables data reception after a call to PauseData .

Syntax

• Swift
• Objective-C

public func processData(connectionId: Int32) throws -> Void

- (void)processData:(int)connectionId;

Remarks

This method reenables data reception for the connection identified by ConnectionId after a previous call to PauseData. When PauseData is called, the DataIn event will not fire for the specified connection. To reenable data reception and allow DataIn to fire, call this method.

Note: This method is used only after previously calling PauseData. It does not need to be called to process incoming data by default.

Reset Method (SSLServer Module)

Reset the component.

Syntax

• Swift
• Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

This method will reset the class's properties to their default values.

Send Method (SSLServer Module)

This method sends binary data to the specified client.

Syntax

• Swift
• Objective-C

public func send(connectionId: Int32, text: Data) throws -> Void

- (void)send:(int)connectionId :(NSData*)text;

Remarks

This method sends binary data to the client identified by ConnectionId. To send text, use the SendText method instead.

When ConnectionsTimeout is set to 0, the class will behave asynchronously. If you are sending data to the remote host faster than it can process it, or faster than the network's bandwidth allows, the outgoing queue might fill up. When this happens, the operation . The BytesSent property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the ReadyToSend event before attempting to send data again.

Note: The ReadyToSend event is not fired when part of the data is sent successfully.

SendBytes Method (SSLServer Module)

This method sends binary data to the specified client.

Syntax

• Swift
• Objective-C

public func sendBytes(connectionId: Int32, data: Data) throws -> Void

- (void)sendBytes:(int)connectionId :(NSData*)data;

Remarks

This method sends binary data to the client identified by ConnectionId. To send text, use the SendText method instead.

When ConnectionsTimeout is set to 0, the class will behave asynchronously. If you are sending data to the remote host faster than it can process it, or faster than the network's bandwidth allows, the outgoing queue might fill up. When this happens, the operation . The BytesSent property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the ReadyToSend event before attempting to send data again.

Note: The ReadyToSend event is not fired when part of the data is sent successfully.

SendFile Method (SSLServer Module)

This method sends the file to the remote host.

Syntax

• Swift
• Objective-C

public func sendFile(connectionId: Int32, fileName: String) throws -> Void

- (void)sendFile:(int)connectionId :(NSString*)fileName;

Remarks

This method sends the file to the client specified by the ConnectionId.

SendLine Method (SSLServer Module)

This method sends a string followed by a new line.

Syntax

• Swift
• Objective-C

public func sendLine(connectionId: Int32, text: String) throws -> Void

- (void)sendLine:(int)connectionId :(NSString*)text;

Remarks

This method is used to send data with line-oriented protocols. The line is followed by .

Please refer to the GetLine method and SingleLineMode property for more information.

SendText Method (SSLServer Module)

This method sends text to the specified client.

Syntax

• Swift
• Objective-C

public func sendText(connectionId: Int32, text: String) throws -> Void

- (void)sendText:(int)connectionId :(NSString*)text;

Remarks

This method sends text to the client identified by ConnectionId. To send binary data, use the SendBytes method instead.

When ConnectionsTimeout is set to 0, the class will behave asynchronously. If you are sending data to the remote host faster than it can process it, or faster than the network's bandwidth allows, the outgoing queue might fill up. When this happens, the operation . The BytesSent property shows how many bytes were sent (if any). If 0 bytes were sent, then you can wait for the ReadyToSend event before attempting to send data again.

Note: The ReadyToSend event is not fired when part of the data is sent successfully.

Shutdown Method (SSLServer Module)

This method shuts down the server.

Syntax

• Swift
• Objective-C

public func shutdown() throws -> Void

- (void)shutdown;

Remarks

This method shuts down the server. Calling this method is equivalent to calling StopListening and then breaking every client connection by calling Disconnect.

StartListening Method (SSLServer Module)

This method starts listening for incoming connections.

Syntax

• Swift
• Objective-C

public func startListening() throws -> Void

- (void)startListening;

Remarks

This method begins listening for incoming connections on the port specified by LocalPort. Once listening, events will fire as new clients connect and data are transferred.

To stop listening for new connections, call StopListening. To stop listening for new connections and to disconnect all existing clients, call Shutdown.

StopListening Method (SSLServer Module)

This method stops listening for new connections.

Syntax

• Swift
• Objective-C

public func stopListening() throws -> Void

- (void)stopListening;

Remarks

This method stops listening for new connections. After being called, any new connection attempts will be rejected. Calling this method does not disconnect existing connections.

To stop listening and to disconnect all existing clients, call Shutdown instead.

Connected Event (SSLServer Module)

This event is fired immediately after a connection completes (or fails).

Syntax

• Swift
• Objective-C

func onConnected(connectionId: Int32, statusCode: Int32, description: String)

- (void)onConnected:(int)connectionId :(int)statusCode :(NSString*)description;

Remarks

If the connection is made normally, StatusCode is 0, and Description is "OK".

If the connection fails, StatusCode has the error code returned by the system. Description contains a description of this code. The value of StatusCode is equal to the value of the system error.

Please refer to the Error Codes section for more information.

ConnectionRequest Event (SSLServer Module)

This event is fired when a request for connection comes from a remote host.

Syntax

• Swift
• Objective-C

func onConnectionRequest(address: String, port: Int32, accept: inout Bool)

- (void)onConnectionRequest:(NSString*)address :(int)port :(int*)accept;

Remarks

This event indicates an incoming connection. The connection is accepted by default. Address and Port will contain information about the remote host requesting the inbound connection. If you want to refuse it, you can set the Accept parameter to False.

DataIn Event (SSLServer Module)

This event is fired when data come in.

Syntax

• Swift
• Objective-C

func onDataIn(connectionId: Int32, text: Data, eol: Bool)

- (void)onDataIn:(int)connectionId :(NSData*)text :(BOOL)EOL;

Remarks

Trapping the DataIn event is your only chance to get the data coming from the other end of the connection specified by ConnectionId. The incoming data are provided through the Text parameter.

EOL indicates whether or not the EOL string was found at the end of Text. If the EOL string was found, then EOL is True.

If Text is part of the data portion of length larger than either DefaultMaxLineLength or with no EOL strings in it, then EOL is False. Please note that this means that one or more DataIn events with EOL set to False can be received during a connection.

If the EOL property is "" (empty string), then EOL can be disregarded (it is always True).

Note: Events are not re-entrant. Performing time-consuming operations within this event will prevent it from firing again in a timely manner and may affect overall performance.

Disconnected Event (SSLServer Module)

This event is fired when a connection is closed.

Syntax

• Swift
• Objective-C

func onDisconnected(connectionId: Int32, statusCode: Int32, description: String)

- (void)onDisconnected:(int)connectionId :(int)statusCode :(NSString*)description;

Remarks

If the connection is broken normally, StatusCode is 0, and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the system. Description contains a description of this code. The value of StatusCode is equal to the value of the system error.

Please refer to the Error Codes section for more information.

Error Event (SSLServer Module)

This event fires information about errors during data delivery.

Syntax

• Swift
• Objective-C

func onError(connectionId: Int32, errorCode: Int32, description: String)

- (void)onError:(int)connectionId :(int)errorCode :(NSString*)description;

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally, the class .

ErrorCode contains an error code and Description contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

ConnectionId indicates the connection for which the error is applicable.

ReadyToSend Event (SSLServer Module)

This event is fired when the component is ready to send data.

Syntax

• Swift
• Objective-C

func onReadyToSend(connectionId: Int32)

- (void)onReadyToSend:(int)connectionId;

Remarks

The ReadyToSend event indicates that the underlying Transmission Control Protocol (TCP)/IP subsystem is ready to accept data after a failed DataToSend. This event is also fired immediately after a connection is established.

SSLClientAuthentication Event (SSLServer Module)

This event is fired when the client presents its credentials to the server.

Syntax

• Swift
• Objective-C

func onSSLClientAuthentication(connectionId: Int32, certEncoded: Data, certSubject: String, certIssuer: String, status: String, accept: inout Bool)

- (void)onSSLClientAuthentication:(int)connectionId :(NSData*)certEncoded :(NSString*)certSubject :(NSString*)certIssuer :(NSString*)status :(int*)accept;

Remarks

This event enables the server to decide whether or not to continue. The Accept parameter is a recommendation on whether to continue or to close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string "OK").

SSLConnectionRequest Event (SSLServer Module)

This event fires when a Secure Sockets Layer (SSL) connection is requested.

Syntax

• Swift
• Objective-C

func onSSLConnectionRequest(connectionId: Int32, supportedCipherSuites: String, supportedSignatureAlgs: String, certStoreType: inout Int32, certStore: inout String, certPassword: inout String, certSubject: inout String)

- (void)onSSLConnectionRequest:(int)connectionId :(NSString*)supportedCipherSuites :(NSString*)supportedSignatureAlgs :(int*)certStoreType :(NSString**)certStore :(NSString**)certPassword :(NSString**)certSubject;

Remarks

This event fires when an SSL connection is requested and SSLProvider is set to Internal. This event provides an opportunity to select an alternative certificate to the connecting client. This event does not fire when SSLProvider is set to Platform.

This event allows the class to be configured to use both RSA and ECDSA certificates depending on the connecting client's capabilities.

ConnectionId is the connection Id of the client requesting the connection.

SupportedCipherSuites is a comma-separated list of cipher suites that the client supports.

SupportedSignatureAlgs is a comma-separated list of certificate signature algorithms that the client supports.

CertStoreType is the store type of the alternate certificate to use for this connection. The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

CertStore is the store name or location of the alternate certificate to use for this connection.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

CertPassword is the password of the certificate store containing the alternate certificate to use for this connection.

CertSubject is the subject of the alternate certificate to use for this connection.

The special value * matches any subject and will select the first certificate in the store. The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

SSLStatus Event (SSLServer Module)

This event is fired to show the progress of the secure connection.

Syntax

• Swift
• Objective-C

func onSSLStatus(connectionId: Int32, message: String)

- (void)onSSLStatus:(int)connectionId :(NSString*)message;

Remarks

The event is fired for informational and logging purposes only. It is used to track the progress of the connection.

Connection Type

This is a currently connected client.

Remarks

This type describes the connection of a client that is currently connected to the class. You may use the different fields of this type to manage the connection.

Fields

Constructors

public init()

Config Settings (SSLServer Module)

TCPServer Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
..
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Base Config Settings

Trappable Errors (SSLServer Module)

SSLServer Errors

SSL Errors

TCP/IP Errors