PipeServer Module

Properties   Methods   Events   Config Settings   Errors  

The PipeServer module is a lightweight server module based on an asynchronous, event-driven architecture. It is designed to balance the load between connections for a fast, powerful server.

Syntax

IPWorksIPC.PipeServer

Remarks

PipeServer is the server complement of PipeClient (which is used to create client applications). They share a common design philosophy and interface. PipeServer is as easy to use as PipeClient.

The client connections are identified by a ConnectionId, an id generated by the component to identify each connection. This id is unique to each connection. PipeServer's events also have ConnectionId as a parameter to identify the connection to which they are related.

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

PipeServer can start to listen on a pipe by setting PipeName and then setting Listening to True. When a client connects the Connected event fires, a ConnectionId is assigned, and communication can start. From this point on, the operation is very similar to PipeClient.

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.

Connections Property (PipeServer Module)

A collection of currently connected clients.

Syntax

• Swift
• Objective-C

public var connections: [Int32: PipeConnection] {
  get {...}
}

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

- (int)connectionCount;

- (BOOL)acceptData:(int)connectionId;

- (int)bytesSent:(int)connectionId;

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

- (int)connectionId:(int)connectionId;

- (NSString*)EOL:(int)connectionId;
- (void)setEOL:(int)connectionId :(NSString*)newEOL;

- (NSData*)EOLB:(int)connectionId;
- (void)setEOLB:(int)connectionId :(NSData*)newEOL;
- (int)maxLineLength:(int)connectionId;
- (void)setMaxLineLength:(int)connectionId :(int)newMaxLineLength;

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

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

Default Value

""

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 PipeConnection type.

This collection is a hashtable type of collection, in which the Connection Id string is used as the key to the desired connection. The Connected event fires when a client connects and provides the Connection Id (key) that identifies the client.

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

DefaultEOL Property (PipeServer 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.

DefaultMaxLineLength Property (PipeServer 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 (PipeServer 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 (PipeServer 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.

Listening Property (PipeServer Module)

If True, the module accepts incoming connections.

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

Use this property to make the class 'listen' (accept connections) on the pipe specified by PipeName. Setting this property to False will make the class stop listening. Please note that this does not close any existing connections.

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

PipeName Property (PipeServer Module)

The name of the pipe.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=pipeName,setter=setPipeName:) NSString* pipeName;

- (NSString*)pipeName;
- (void)setPipeName :(NSString*)newPipeName;

Default Value

""

Remarks

This property specifies the name of the pipe on which to accept connections. Clients must use this name when establishing a connection to PipeServer.

Config Method (PipeServer 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 (PipeServer 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 (PipeServer Module)

This method 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 (PipeServer 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.

Send Method (PipeServer 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 (PipeServer 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 (PipeServer 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 (PipeServer 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 (PipeServer 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 (PipeServer 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 (PipeServer 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 pipe specified by PipeName.

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

StopListening Method (PipeServer 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 (PipeServer Module)

Fired immediately after a connection completes.

Syntax

• Swift
• Objective-C

func onConnected(connectionId: Int32)

- (void)onConnected:(int)connectionId;

Remarks

This event fires immediately after a client connects. The ConnectionId parameter identifies the client connection.

DataIn Event (PipeServer 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 (PipeServer Module)

Fires when a client disconnects.

Syntax

• Swift
• Objective-C

func onDisconnected(connectionId: Int32)

- (void)onDisconnected:(int)connectionId;

Remarks

This event fires when a client disconnects. The ConnectionId parameters identifies the client that is disconnected.

Error Event (PipeServer 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 (PipeServer Module)

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 pipe is ready to accept data after a failed SendBytes. The event is also fired immediately after a connection to the remote host is established.

PipeConnection Type

A currently connected client.

Remarks

This type describes the connection of a client which is currently connected to the class. The connection may be managed using the different fields of this type.

Fields

Constructors

public init()

Config Settings (PipeServer Module)

PipeServer Config Settings

Base Config Settings

Trappable Errors (PipeServer Module)

PipeServer Errors