Share via


PipeServer Class

The PipeServer class provides support for the server side of a named pipe connection.

Syntax

class PipeServer extends Object

Run On

Called

Methods

  Method Description
Gg912992.pubmethod(en-us,AX.60).gif blockingMode
Gg912992.pubmethod(en-us,AX.60).gif cancelTimeOut Cancels a previous method call to the setTimeOut method. (Inherited from Object.)
Gg912992.pubmethod(en-us,AX.60).gif connect Waits for a client to connect to the named pipe.
Gg912992.pubmethod(en-us,AX.60).gif disconnect Disconnects the server end of the named pipe instance from a client process.
Gg912992.pubmethod(en-us,AX.60).gif equal Determines whether the specified object is equal to the current one. (Inherited from Object.)
Gg912992.pubmethod(en-us,AX.60).gif errorCode
Gg912992.pubmethod(en-us,AX.60).gif getTimeOutTimerHandle Returns the timer handle for the object. (Inherited from Object.)
Gg912992.pubmethod(en-us,AX.60).gif handle Retrieves the handle of the class of the object. (Inherited from Object.)
Gg912992.pubmethod(en-us,AX.60).gif new Creates a new instance of the PipeServer class. (Overrides the new Method.)
Gg912992.pubmethod(en-us,AX.60).gif notify Releases the hold on an object that has called the wait method on this object. (Inherited from Object.)
Gg912992.pubmethod(en-us,AX.60).gif notifyAll Releases a lock on the object that was issued by the wait method on this object. (Inherited from Object.)
Gg912992.pubmethod(en-us,AX.60).gif objectOnServer Determines whether the object is on a server. (Inherited from Object.)
Gg912992.pubmethod(en-us,AX.60).gif owner Returns the instance that owns the object. (Inherited from Object.)
Gg912992.pubmethod(en-us,AX.60).gif read Reads data from the named pipe, written to by a pipe client.
Gg912992.pubmethod(en-us,AX.60).gif setTimeOut Sets up the scheduled execution of a specified method. (Inherited from Object.)
Gg912992.pubmethod(en-us,AX.60).gif toString Returns a string that represents the current object. (Inherited from Object.)
Gg912992.pubmethod(en-us,AX.60).gif usageCount Returns the current number of references, that is, the value of the reference counter, that the object has. (Inherited from Object.)
Gg912992.pubmethod(en-us,AX.60).gif wait Pauses a process. (Inherited from Object.)
Gg912992.pubmethod(en-us,AX.60).gif xml Returns an XML string that represents the current object. (Inherited from Object.)

Top

Remarks

A named pipe is created when a PipeServer object is created by using the PipeServer.new method. The pipe is created with read access and in message mode. The name of the pipe is automatically prefixed with \\.\pipe\Dynamics. The current session SID is postfixed to the name.

The support provided for pipe connections on the server is restricted for the following security reasons:

  • The pipe is supported only for the current logon session on the computer that the session was created on.

  • The user who creates the pipe is the only person who can communicate with that pipe.

Inheritance Hierarchy

Object Class
  PipeServer Class