# NSPort class reference

richard@brainstorm.co.uk
mccallum@gnu.ai.mit.edu
1997,2002 Free Software Foundation, Inc.
Software documentation for the NSMessagePort class
Foundation/NSPort.h
An NSPort implementation for network object communications which can be used for interthread/interprocess communications on the same host, but not between different hosts.
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.
Software documentation for the NSPort class
Foundation/NSPort.h
NSCoding
NSCopying

`NSPort` is an abstract class defining interfaces underlying communications in the distributed objects framework. Each side of a connection will have an `NSPort` object, responsible for sending and receiving NSPortMessage s, which are then passed to delegates when received. The `NSPort` must be added to the NSRunLoop as an input source.

This class also implements the functionality of the `NSMachPort` class on OS X.

Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.
Warning the underscore at the start of the name of this instance variable indicates that, even though it is not technically private, it is intended for internal use within the package, and you should not use the variable in other code.
port
Basic constructor returns object capable of send and receive.
By default, the port returned is an instance of NSMessagePort capable only of host-local communication. However, the `NSPortIsMessagePort` user default may be set to `NO` to change the behavior so that the returned value is an instance of the NSSocketPort class.
portWithMachPort:
machPort
NSMachPort compatibility method.
addConnection:
aConnection
toRunLoop:
aLoop
forMode:
aMode
Adds to run loop as input source to be notified for input in given mode. This method is for use by subclasses.
delegate
Returns the object that received messages will be passed off to.
init
Basic initializer sets up object capable of send and receive. See +port for more details.
initWithMachPort:
machPort
NSMachPort compatibility method.
invalidate
Mark port as invalid, deregister with listeners and cease further network operations. Subclasses should override and call super.
isValid
Returns whether port has been marked invalid.
machPort
NSMachPort compatibility.
removeConnection:
aConnection
fromRunLoop:
aLoop
forMode:
aMode
Removes from run loop as input source to be notified for input in given mode. This method is for use by subclasses.
reservedSpaceLength
Returns amount of space used for header info at beginning of messages. Subclasses should override (this implementation returns 0).
sendBeforeDate:
when
components:
components
from:
receivingPort
reserved:
length
Internal method for sending message, for use by subclasses.
sendBeforeDate:
when
msgid:
msgid
components:
components
from:
receivingPort
reserved:
length
Internal method for sending message, for use by subclasses.
setDelegate:
anObject
Sets the object that received messages will be passed off to.
Software documentation for the NSSocketPort class
Foundation/NSPort.h

An NSPort implementation for network object communications based on BSD sockets. Can be used for interthread/interprocess communications between same or different hosts (though on same host NSMessagePort will be more efficient).

Note that this class is incompatible with the latest OS X version.

Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
existingPortWithNumber:
number
onHost:
aHost
Look up and return an existing `NSSocketPort` given a host and number, or return `nil` if one has not been created.
portWithNumber:
number
onHost:
aHost
forceAddress:
addr
listener:
shouldListen
This is the preferred initialisation method for `NSSocketPort`.
number
should be a TCP/IP port number or may be zero for a port on the local host.
aHost
should be the host for the port or may be `nil` for the local host.
addr
is the IP address that MUST be used for this port - if it is `nil` then, for the local host, the port uses ALL IP addresses, and for a remote host, the port will use the first address that works.
shouldListen
specifies whether to listen on the port initially.
setClientOptionsForTLS:
options
Sets the default options for use of TLS by socket ports.
Setting `nil` (the default) means that TLS is not used.
Setting an empty dictionary means that TLS is used with normal options.
setServerOptionsForTLS:
options
Sets the default options for use of TLS by socket ports.
Setting `nil` (the default) means that TLS is not used.
Setting an empty dictionary means that TLS is used with normal options.
address
Returns IP address of underlying socket.
getFds:
fds
count:
count
This is a callback method used by the NSRunLoop class to determine which descriptors to watch for the port.
handlePortMessage:
m
Delegates processing of a message.
host
Returns host that the underlying socket is connected to.
portNumber
Returns port number of underlying socket.
setClientOptionsForTLS:
options
Overrides the default options for use of TLS by the receiver.
Setting `nil` (the default) means that TLS is not used.
Setting an empty dictionary means that TLS is used with normal options.
This method has no effect on network sessions which are already established.
Sets the TLS options for network connections created by this port acting as a network client.
setServerOptionsForTLS:
options
Overrides the default options for use of TLS by the receiver.
Setting `nil` (the default) means that TLS is not used.
Setting an empty dictionary means that TLS is used with normal options.
This method has no effect on network sessions which are already established.
Sets the TLS options for network connections created by this port acting as a network server.
Software documentation for the NSObject(NSPortDelegateMethods) category
Foundation/NSPort.h
Description forthcoming.
handlePortMessage:
aMessage
Subclasses of NSPort send this message to their delegate on receipt of a port message.