# NetBase reference

Revision 1
November 8, 2003
Andrew Ruder
Software documentation for the NetApplication class
NetBase.h
RunLoopEvents
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
Description forthcoming.
netclassesMajorVersion
Return the major version number of the netclasses framework. If the version is 1.03, this will return 1.
netclassesMinorVersion
Return the minor version number of the netclasses framework. If the version is 1.03, this will return 3.
netclassesVersion
Return the version string for the netclasses framework. If the version is 1.03, this will return @"1.03".
sharedInstance
There can be only one instance of NetApplication. This method will return that one instance.
closeEverything
Calls -disconnectObject: on every object currently in the runloop.
connectObject:
anObject
Inserts anObject into the runloop (and retains it). anObject should implement either the <NetPort> or <NetObject> protocols. Throws a `NetException` if the class follows neither protocol. After connecting anObject, it will begin to receive the methods designated by its respective protocol. anObject should only be connected with this after its transport is set.
disconnectObject:
anObject

Removes anObject from the runloop and releases it. anObject will no longer receive messages outlined by its protocol. Does not close the descriptor of anObject. anObject will receive a [<NetObject>-connectionLost] message or a [<NetPort>-connectionLost] message.

If any object should lose its connection, this will automatically be called with that object as its argument.

netObjectArray
Return an array of all net objects currently being handled by netclasses
portArray
Return an array of all port objects currently being handled by netclasses
receivedEvent:
data
type:
type
extra:
extra
forMode:
mode
Should not be called. Used internally by NetApplication to receive events from the runloop.
timedOutEvent:
data
type:
type
forMode:
mode
Should not be called. Used internally by NetApplication to receive timed out events notifications from the runloop.
transportNeedsToWrite:
aTransport
This is called to notify NetApplication that aTransport has data that needs to be written out. Only after this method is called will aTransport begin to receive [<NetTransport>-writeData:] messages with a `nil` argument when it can write.
Software documentation for the NetObject protocol
NetBase.h
NSObject
This protocol should be implemented by an object used in a connection. When a connection is received by a <NetPort> , the object attached to the port is created and given the transport.
connectionEstablished:
aTransport
Called when a connection has been established, and gives the object the transport used to actually transport the data. aTransport will implement <NetTransport> .
connectionLost
Called when [NetApplication -disconnectObject:] is called with this object as a argument. This object will no longer receive data or other messages after it is disconnected.
dataReceived:
data
data
is data read in from the connection.
transport
Should return the transport given to the object by -connectionEstablished:
Software documentation for the NetPort protocol
NetBase.h
NSObject
Represents a class that acts as a port. Each port allows a object type to be attached to it, and it will instantiate an object of that type upon receiving a new connection.
close
Should close the file descriptor.
connectionLost
Called when the object has [NetApplication -disconnectObject:] called on it.
desc
Returns the low-level file descriptor.
newConnection
Called when a new connection has been detected by NetApplication . The port should should use this new connection to instantiate a object of the class set by -setNetObject: .
setNetObject:
aClass
Sets the class of the object that should be attached to the port. This class should implement the <NetObject> protocol.
Software documentation for the NetTransport protocol
NetBase.h
NSObject
A protocol used for the actual transport class of a connection. A transport is a low-level object which actually handles the physical means of transporting data to the other side of the connection through methods such as -readData: and -writeData: .
close
Should close the file descriptor.
desc
Returns a file descriptor representing the connection.
isDoneWriting
Return `YES` if no more data is waiting to be written, and `NO` otherwise. Used by NetApplication to determine when it can stop checking the transport for writing availability.
localHost
Returns an object representing the local side of a connection. The actual object depends on the implementation of this protocol.
readData:
maxReadSize
Called by NetApplication when it is safe to write. Should return data read from the connection with a maximum size of maxReadSize. If maxReadSize should be zero, all data available on the connection should be returned.
remoteHost
Returns an object representing the remote side of a connection. The actual object depends on the implementation of this protocol.
writeData:
data
This should serve two purposes. When data is not `nil`, the transport should store the data, and then call [NetApplication -transportNeedsToWrite:] to notify NetApplication that the transport needs to write. When data is `nil`, the transport should assume that it is actually safe to write the data and should do so at this time. NetApplication will call -writeData: with a `nil` argument when it is safe to write
Software documentation for the RunLoopEvents protocol
NetBase.h
Used for OS X compatibility. OS X does not have the RunLoopEvents protocol. This is a GNUstep-specific extension. This must be recreated on OS X to compile netclasses.
receivedEvent:
data
type:
type
extra:
extra
forMode:
mode
OS X compatibility function. This is a callback called by the run loop when an event has been received.
timedOutEvent:
data
type:
type
forMode:
mode
OS X compatibility function. This is a callback called by the run loop when an event has timed out.
NetBase types

Used for OS X compatibility. This type is an extension to GNUstep. On OS X, a compatibility layer is created to recreate the GNUstep extensions using OS X extensions.
ET_RDESC
ET_WDESC
ET_RPORT
ET_EDESC
NetBase variables

Should be thrown when a non-recoverable exception occurs on a connection. The connection should be closed immediately.
Thrown when a recoverable exception occurs on a connection or otherwise.