Retain/Release and DO patches from Richard Frith-MacDonald

git-svn-id: svn+ssh://svn.gna.org/svn/gnustep/libs/base/trunk@2571 72102866-910b-0410-8b05-ffd578937521

Tools/Makefile

@@ -0,0 +1,13 @@
+include $(GNUSTEP_SYSTEM_ROOT)/Makefiles/common.make
+
+# The application to be compiled
+TOOL_NAME = gdomap
+
+# The source files to be compiled
+gdomap_C_FILES = gdomap.c
+
+-include Makefile.preamble
+
+include $(GNUSTEP_SYSTEM_ROOT)/Makefiles/tool.make
+
+-include Makefile.postamble

Tools/Makefile.postamble

@@ -0,0 +1,46 @@
+#
+#   Makefile.postamble
+#
+#   Project specific makefile rules
+#
+#   Uncomment the targets you want.
+#   The double colons (::) are important, do not make them single colons
+#   otherwise the normal makefile rules will not be performed.
+#
+
+# Things to do before compiling
+# before-all::
+
+# Things to do after compiling
+# after-all::
+
+# Things to do before installing
+before-install::
+	$(INSTALL) -m 05755 gdomap $(GNUSTEP_SYSTEM_ROOT)/Tools
+
+# Things to do after installing
+# after-install::
+
+# Things to do before uninstalling
+# before-uninstall::
+
+# Things to do after uninstalling
+# after-uninstall::
+
+# Things to do before cleaning
+# before-clean::
+
+# Things to do after cleaning
+# after-clean::
+
+# Things to do before distcleaning
+# before-distclean::
+
+# Things to do after distcleaning
+# after-distclean::
+
+# Things to do before checking
+# before-check::
+
+# Things to do after checking
+# after-check::

Tools/Makefile.preamble

@@ -0,0 +1,43 @@
+#
+#   Makefile.preamble
+#
+#   Project specific makefile variables, and additional
+#
+#   Do not put any Makefile rules in this file, instead they should
+#   be put into Makefile.postamble.
+#
+
+#
+# Flags dealing with compiling and linking
+#
+
+# Additional flags to pass to the preprocessor
+ADDITIONAL_CPPFLAGS += 
+
+# Additional flags to pass to the Objective-C compiler
+ADDITIONAL_OBJCFLAGS += 
+
+# Additional flags to pass to the C compiler
+ADDITIONAL_CFLAGS += 
+
+# Additional include directories the compiler should search
+ADDITIONAL_INCLUDE_DIRS +=
+
+# Additional LDFLAGS to pass to the linker
+# ADDITIONAL_LDFLAGS += 
+
+# Additional library directories the linker should search
+ADDITIONAL_LIB_DIRS += 
+
+# Additional libraries when linking tools
+ADDITIONAL_TOOL_LIBS +=
+
+# Additional libraries when linking applications
+ADDITIONAL_GUI_LIBS +=
+
+#
+# Flags dealing with installing and uninstalling
+#
+
+# Additional directories to be created during installation
+ADDITIONAL_INSTALL_DIRS +=

Tools/gdomap.h

@@ -0,0 +1,198 @@
+/* Include for communications with GNUstep Distributed Objects name server
+   Copyright (C) 1996, 1997 Free Software Foundation, Inc.
+
+   Written by:  Richard Frith-Macdonald <richard@brainstorm.co.uk>
+   Created: October 1996
+
+   This file is part of the GNUstep Base Library.
+
+   This library is free software; you can redistribute it and/or
+   modify it under the terms of the GNU Library General Public
+   License as published by the Free Software Foundation; either
+   version 2 of the License, or (at your option) any later version.
+
+   This library is distributed in the hope that it will be useful,
+   but WITHOUT ANY WARRANTY; without even the implied warranty of
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+   Library General Public License for more details.
+
+   You should have received a copy of the GNU Library General Public
+   License along with this library; if not, write to the Free
+   Software Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
+   */
+
+/*
+ *	About the GNU Distributed Objects name-server
+ *
+ *	The name server is intended to work with both the UDP and the TCP
+ *	protocols.  It is intended that the TCP interface be used by
+ *	GNUstep programs, while the UDP interface is intended primarily
+ *	for communication between name servers on different machines.
+ *
+ *	The communications protocol is identical for both TCP and UDP and
+ *	consists of a simple request-response sequence.
+ *
+ *	Each request is a single message consisting of -
+ *		a single byte request type,
+ *		a single byte giving name length,
+ *		a single byte specifying the type of port being registered
+ *		or looked up, or a nul byte for probe operations.
+ *		a single nul byte.
+ *		a four byte port number in network byte order must be
+ *		present for register operations, otherwise this is zero.
+ *		a service name of 0 to GDO_NAME_MAX_LEN bytes (or an IP
+ *		address in network byte order for probe operations)
+ *		0 to GDO_NAME_MAX_LEN nul bytes padding the service name to its
+ *		full size.
+ *		a terminating nul byte.
+ *		The total is always sent in a packet with everything after the
+ *		service name (except the final byte) cleared to nul bytes.
+ *
+ *	Each response consists of at least 4 bytes and depends on the
+ *	corresponding request type and where it came from as follows -
+ *
+ *	Request type	Effect
+ *
+ *	GDO_LOOKUP	Looks up the server name and returns its port number.
+ *			Response is the port number in network byte order,
+ *			or zero if the named server was not registered.
+ *
+ *	GDO_REGISTER	Registers the given server name with a port number.
+ *			This service is only available to processes on the
+ *			same host as the name server.
+ *			Response is the port number in network byte order,
+ *			or zero if the named server was already registered.
+ *
+ *	GDO_UNREG	Un-register the server name and return old port number.
+ *			This service is only available to a process on the
+ *			same host as this name server.
+ *			Response is the old port number in network byte order,
+ *			or zero if the name could not be un-registered.
+ *
+ *	GDO_SERVERS	Return a list of the known servers on the local net.
+ *			Response is an unsigned long (in network byte order)
+ *			saying how many servers the name server knows about,
+ *			followed by a list of their IP addresses in network
+ *			byte order.
+ *			NB. This response may not be possible over UDP as the
+ *			response length may exceed the maximum UDP packet size.
+ *
+ *	The following are used for communications between name servers -
+ *
+ *	GDO_PROBE	Requests a response
+ *			For a request from a name server via UDP there is no
+ *			response, but a GDO_REPLY request is sent.
+ *			For a request from a non-name-server, or a TCP
+ *			connect, the response is the port number of this
+ *			server in network byte order.
+ *
+ *	GDO_PREPLY	Replies to a GDO_PROBE via UDP from a name server.
+ *			No response is sent.
+ *
+ *
+ *	HOW IT WORKS AND WHY (implementation notes)
+ *
+ *	1.  The fixed size of a request packet was chosen for maximum
+ *	    ease and speed of implementation of a non-blocking name server.
+ *	    The server knows how much it needs to read and can therefore
+ *	    usually do a read as a single operation since it doesn't have
+ *	    to read a little, figure out request length, allocate a buffer,
+ *	    and read the rest.
+ *
+ *	    The server name length (bytes) is specified - no assumptions
+ *	    should be made about whether the name contains nul characters
+ *	    or indeed about the name at all.  This is future-proofing.
+ *
+ *	2.  Why UDP as well as TCP?
+ *	    The OpenStep specification says that a connection may be
+ *	    established to any host on the local network which supplys a
+ *	    named service if the host name is specified as '*'
+ *
+ *	    This means that the application must poll to see if it can
+ *	    find a server with the name it wants.  The polling could take
+ *	    a huge amount of time!
+ *
+ *	    To make this all easier - the server is capable of supplying
+ *	    a list of those hosts on the local network which it knows to
+ *	    have (or have had) a name server running on them.
+ *
+ *	    The application then need only poll those name servers to find
+ *	    the service it wants.
+ *
+ *	    However - to give the application a list of hosts, the name
+ *	    server must have got the information from somewhere.
+ *	    To gather the information the server has to poll the machines
+ *	    on the net which would take ages using TCP since attempts to
+ *	    talk to machines which are down or do not exist will take a
+ *	    while to time out.
+ *
+ *	    To make things speedy, the server sends out GDO_PROBE requests
+ *	    on UDP to all the machines on the net when it starts up.
+ *	    Each machine which has a name server notes that the new name
+ *	    server has started up and sends back a GDOPREPLY packet so
+ *	    that the new name server will know about it.
+ *
+ *	    Things are never perfect though - if a name server dies, the
+ *	    other name servers won't know, and will continute to tell
+ *	    applications that it is there.
+ *
+ *	3.  Port type codes - these are used to say what the port is for so
+ *	    that clients can look up only the names that are relevant to them.
+ *	    This is to permit the name server to be used for multiple
+ *	    communications protocols (at the moment, tcp or udp) and for
+ *	    different systems (distributed objects or others).
+ *	    This guarantees that if one app is using DO over UDP, its services
+ *	    will not be found by an app which is using DO over TCP.
+ */
+
+#define	GDOMAP_PORT	(538)	/* The well-known port for name server.	*/
+
+/*
+ *	Request type codes
+ */
+#define	GDO_REGISTER	'R'
+#define	GDO_LOOKUP	'L'
+#define	GDO_UNREG	'U'
+#define	GDO_SERVERS	'S'
+#define	GDO_PROBE	'P'
+#define	GDO_PREPLY	'p'
+
+/*
+ *	Port type codes
+ */
+#define	GDO_NET_MASK	0x70	/* Network protocol of port.		*/
+#define	GDO_NET_TCP	0x10
+#define	GDO_NET_UDP	0x10
+#define	GDO_SVC_MASK	0x0f	/* High level protocol of port.		*/
+#define	GDO_SVC_GDO	0x01
+#define	GDO_SVC_FOREIGN	0x02
+
+/* tcp/ip distributed object server.	*/
+#define	GDO_TCP_GDO	(GDO_NET_TCP|GDO_SVC_GDO)
+
+/* udp/ip distributed object server.	*/
+#define	GDO_UDP_GDO	(GDO_NET_UDP|GDO_SVC_GDO)
+
+/* tcp/ip simple socket connection.	*/
+#define	GDO_TCP_FOREIGN	(GDO_NET_TCP|GDO_SVC_FOREIGN)
+
+/* udp/ip simple socket connection.	*/
+#define	GDO_UDP_FOREIGN	(GDO_NET_UDP|GDO_SVC_FOREIGN)
+
+
+#define	GDO_NAME_MAX_LEN	255	/* Max length registered name.	*/
+
+/*
+ *	Structure to hold a request.
+ */
+typedef	struct	{
+    unsigned char	rtype;		/* Type of request being made.	*/
+    unsigned char	nsize;		/* Length of the name to use.	*/
+    unsigned char	ptype;		/* Type of port registered.	*/
+    unsigned char	dummy;
+    unsigned int	port;
+    char		name[GDO_NAME_MAX_LEN+1];
+} gdo_req;
+
+#define	GDO_REQ_SIZE	sizeof(gdo_req)	/* Size of a request packet.	*/
+