Up

NSPortCoder class reference

Authors

Andrew Kachites McCallum (mccallum@gnu.ai.mit.edu)

Version: 1.44

Date: 2003/07/31 23:49:31

Copyright: (C) 1997,2000 Free Software Foundation, Inc.


Contents -

  1. Software documentation for the NSPortCoder class
  2. Software documentation for the NSPortCoder(Private) category

Software documentation for the NSPortCoder class

NSPortCoder : NSCoder

Declared in:
Foundation/NSPortCoder.h
Standards:

This class is an NSCoder implementation specialized for sending objects over network connections for immediate use (as opposed to the archivers which persist objects for reconstitution after an indefinite term). It is used to help implement the distributed objects framework by the NSConnection class. Even for highly specialized applications, you probably do not need to use this class directly.

Method summary

portCoderWithReceivePort: sendPort: components: 

+ (NSPortCoder*) portCoderWithReceivePort: (NSPort*)recv sendPort: (NSPort*)send components: (NSArray*)comp;

Create a new instance for communications over send and recv, and send an initial message through send as specified by comp.


connection 

- (NSConnection*) connection;

Returns the NSConnection using this instance.


decodePortObject 

- (NSPort*) decodePortObject;

Return port object previously encoded by this instance. Mainly for use by the ports themselves.


dispatch 

- (void) dispatch;

Processes and acts upon the initial message the receiver was initialized with..


encodePortObject: 

- (void) encodePortObject: (NSPort*)aPort;

Encodes aPort so it can be sent to the receiving side of the connection. Mainly for use by the ports themselves.


initWithReceivePort: sendPort: components: 

- (id) initWithReceivePort: (NSPort*)recv sendPort: (NSPort*)send components: (NSArray*)comp;

Initialize a new instance for communications over send and recv, and send an initial message through send as specified by comp.


isBycopy 

- (BOOL) isBycopy;

Returns YES if receiver is in the process of encoding objects by copying them (rather than substituting a proxy). This method is mainly needed internally and by subclasses.


isByref 

- (BOOL) isByref;

Returns YES if receiver will substitute a proxy when encoding objects rather than by copying them. This method is mainly needed internally and by subclasses.


Software documentation for the NSPortCoder(Private) category

NSPortCoder(Private)

Declared in:
Foundation/NSPortCoder.h
Standards:

Warning this category is private, which means that the methods are for internal use by the package. You should not use them in external code.

Method summary

_components 

- (NSMutableArray*) _components;

Warning the underscore at the start of the name of this method indicates that it is private, for internal use only, and you should not use the method in your code.



Up