| Inherits from | |
| Conforms to | |
| Framework | /System/Library/Frameworks/Foundation.framework |
| Availability | Available in Mac OS X v10.0 and later. |
| Companion guide | |
| Declared in | NSPort.h |
NSMachPort is a subclass of NSPort that can be used as an endpoint for distributed object connections (or raw messaging). NSMachPort is an object wrapper for a Mach port, the fundamental communication port in Mac OS X. NSMachPort allows for local (on the same machine) communication only. A companion class, NSSocketPort, allows for both local and remote distributed object communication, but may be more expensive than NSMachPort for the local case.
To use NSMachPort effectively, you should be familiar with Mach ports, port access rights, and Mach messages. See the Mach OS documentation for more information.
NSMachPort conforms to the NSCoding protocol, but only supports coding by an NSPortCoder. NSPort and its subclasses do not support archiving.Creates and returns a port object configured with the given Mach port.
+ (NSPort *)portWithMachPort:(uint32_t)machPort
The Mach port for the new port. This parameter should originally be of type mach_port_t.
An NSMachPort object that uses machPort to send or receive messages.
Creates the port object if necessary. Depending on the access rights associated with machPort, the new port object may be usable only for sending messages.
NSPort.hCreates and returns a port object configured with the specified options and the given Mach port.
+ (NSPort *)portWithMachPort:(uint32_t)machPort options:(NSUInteger)options
The Mach port for the new port. This parameter should originally be of type mach_port_t.
Specifies options for what to do with the underlying port rights when the NSMachPort object is invalidated or destroyed. For a list of constants, see “Mach Port Rights.”
An NSMachPort object that uses machPort to send or receive messages.
Creates the port object if necessary. Depending on the access rights associated with machPort, the new port object may be usable only for sending messages.
NSPort.hReturns the receiver’s delegate.
- (id < NSMachPortDelegate >)delegate
The receiver’s delegate.
NSPort.hInitializes a newly allocated NSMachPort object with a given Mach port.
- (id)initWithMachPort:(uint32_t)machPort
The Mach port for the new port. This parameter should originally be of type mach_port_t.
Returns an initialized NSMachPort object that uses machPort to send or receive messages. The returned object might be different than the original receiver
Depending on the access rights for machPort, the new port may be able to only send messages. If a port with machPort already exists, this method deallocates the receiver, then retains and returns the existing port.
This method is the designated initializer for the NSMachPort class.
NSPort.hInitializes a newly allocated NSMachPort object with a given Mach port and the specified options.
- (id)initWithMachPort:(uint32_t)machPort options:(NSUInteger)options
The Mach port for the new port. This parameter should originally be of type mach_port_t.
Specifies options for what to do with the underlying port rights when the NSMachPort object is invalidated or destroyed. For a list of constants, see “Mach Port Rights.”
Returns an initialized NSMachPort object that uses machPort to send or receive messages. The returned object might be different than the original receiver
Depending on the access rights for machPort, the new port may be able to only send messages. If a port with machPort already exists, this method deallocates the receiver, then retains and returns the existing port.
NSPort.hReturns as an int the Mach port used by the receiver.
- (uint32_t)machPort
The Mach port used by the receiver. Cast this value to a mach_port_t when using it with Mach system calls.
NSPort.hRemoves the receiver from the run loop mode mode of runLoop.
- (void)removeFromRunLoop:(NSRunLoop *)runLoop forMode:(NSString *)mode
The run loop from which to remove the receiver.
The run loop mode from which to remove the receiver.
When the receiver is removed, the run loop stops monitoring the Mach port for incoming messages.
NSPort.hSchedules the receiver into the run loop mode mode of runLoop.
- (void)scheduleInRunLoop:(NSRunLoop *)runLoop forMode:(NSString *)mode
The run loop to which to add the receiver.
The run loop mode in which to add the receiver.
When the receiver is scheduled, the run loop monitors the mach port for incoming messages and, when a message arrives, invokes the delegate method handleMachMessage:.
NSPort.hSets the receiver’s delegate to a given object.
- (void)setDelegate:(id < NSMachPortDelegate >)anObject
The delegate for the receiver.
NSPort.hUsed to remove access rights to a mach port when the NSMachPort object is invalidated or destroyed.
enum {
NSMachPortDeallocateNone = 0,
NSMachPortDeallocateSendRight = (1 << 0),
NSMachPortDeallocateReceiveRight = (1 << 1)
};
NSMachPortDeallocateNoneDo not remove any send or receive rights.
Available in Mac OS X v10.5 and later.
Declared in NSPort.h.
NSMachPortDeallocateSendRightDeallocate a send right when the NSMachPort object is invalidated or destroyed.
Available in Mac OS X v10.5 and later.
Declared in NSPort.h.
NSMachPortDeallocateReceiveRightRemove a receive right when the NSMachPort object is invalidated or destroyed.
Available in Mac OS X v10.5 and later.
Declared in NSPort.h.
Last updated: 2009-04-14
Mac OS X Reference Library Networking, Internet, & Web: Sockets & TCP NSMachPort Class Reference