[docs] xmldocs - docelic modified 9 files

docs at icdevgroup.org docs at icdevgroup.org
Thu Feb 9 19:52:34 EST 2006


User:      docelic
Date:      2006-02-10 00:52:33 GMT
Modified:  refs     SocketFile SocketPerms
Added:     glossary SOAP-RPC
Added:     refs     SOAP SOAP_Host SOAP_MaxRequests SOAP_Perms
Added:              SOAP_Socket SOAP_StartServers
Log:
* Document most of SOAP directives

Revision  Changes    Path
1.1                  xmldocs/glossary/SOAP-RPC


rev 1.1, prev_rev 1.0
Index: SOAP-RPC
===================================================================
<ulink url='http://www.w3.org/TR/soap/'>SOAP</ulink> resource at W3C.



1.3       +1 -1      xmldocs/refs/SocketFile


rev 1.3, prev_rev 1.2
Index: SocketFile
===================================================================
RCS file: /var/cvs/xmldocs/refs/SocketFile,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- SocketFile	18 Nov 2005 23:15:02 -0000	1.2
+++ SocketFile	10 Feb 2006 00:52:33 -0000	1.3
@@ -9,7 +9,7 @@
 
 __NAME__ synopsis
 <group choice='req'>
-	<arg choice='plain'>filename</arg>
+	<arg choice='plain'><replaceable>filename</replaceable></arg>
 </group>
 __END__
 



1.6       +4 -1      xmldocs/refs/SocketPerms


rev 1.6, prev_rev 1.5
Index: SocketPerms
===================================================================
RCS file: /var/cvs/xmldocs/refs/SocketPerms,v
retrieving revision 1.5
retrieving revision 1.6
diff -u -r1.5 -r1.6
--- SocketPerms	19 Nov 2005 22:37:41 -0000	1.5
+++ SocketPerms	10 Feb 2006 00:52:33 -0000	1.6
@@ -20,12 +20,15 @@
 Prepend a starting <literal>0</literal> to indicate an octal value. The
 directive can be overridden from the command line using <literal>interchange
 -r SocketPerms=<replaceable>value</replaceable></literal>.
+</para><para>
+The default value is <literal>0660</literal>, which allows only programs
+running under your &IC; server UID or GID to access the socket.
 __END__
 
 __NAME__ notes
 Although not recommended in practice, it sometimes makes sense to
 set the permissions to <literal>0666</literal> (world-writable) to 
-easier debug problems.
+debug problems easier.
 __END__
 
 



1.1                  xmldocs/refs/SOAP


rev 1.1, prev_rev 1.0
Index: SOAP
===================================================================
__NAME__ purpose
enable handling of SOAP RPC requests
__END__

__NAME__ see also
SOAP_Host, SOAP_Socket, SOAP_Perms, Soap_MaxRequests, SOAP_StartServers
__END__

__NAME__ synopsis
<group choice='req'>
	<arg choice='plain'>No</arg>
	<arg choice='plain'>Yes</arg>
</group>
__END__


__NAME__ description
Enable handling of &glos-SOAP-RPC; requests.
</para><para>
__END__

__NAME__ example: Enabling SOAP RPC protocol
<programlisting>
SOAP Yes
</programlisting>
__END__




1.1                  xmldocs/refs/SOAP_Host


rev 1.1, prev_rev 1.0
Index: SOAP_Host
===================================================================
__NAME__ purpose
specify list of hosts that are allowed to connect and issue SOAP RPC requests
__END__

__NAME__ see also
SOAP_Host, SOAP_Socket, SOAP_Perms, Soap_MaxRequests, SOAP_StartServers
__END__

__NAME__ notes
This directive exists, but is currently unused in &IC; code and
therefore has no effect on execution of SOAP RPC requests.
__END__

__NAME__ synopsis
<group choice='req'>
	<arg choice='plain' rep='repeat'><replaceable>hostname_or_IP</replaceable></arg>
</group>
__END__


__NAME__ description
The directive specifies the list of hosts allowed to connect
and issue &glos-SOAP-RPC; requests.
</para><para>
Multiple entries should be space-separated, and the default value is
"<literal>localhost 127.0.0.1</literal>".
__END__

__NAME__ example: Specifying SOAP_Host
<programlisting>
SOAP_Host localhost 127.0.0.1 &def-hostname;
</programlisting>
__END__




1.1                  xmldocs/refs/SOAP_MaxRequests


rev 1.1, prev_rev 1.0
Index: SOAP_MaxRequests
===================================================================
__NAME__ purpose
define maximum number of per-server SOAP RPC response deliveries before respawn
__END__


__NAME__ see also
SOAP, SOAP_StartServers, SOAP_Socket, MaxRequestsPerChild
__END__


__NAME__ synopsis
<group choice='req'>
	<arg choice='plain'><replaceable>count</replaceable></arg>
</group>
__END__


__NAME__ description
The directive defines the maximum number
of &glos-SOAP-RPC; responses each server instance will carry out before 
closing down and respawning.
</para><para>
The whole point of a periodic respawn is to prevent accumulation of 
eventual memory leaks.
</para><para>
The default value is <literal>50</literal>. In case the default value is
somehow cleared, the hard-coded default is <literal>10</literal>.
__END__

__NAME__ notes
__END__


__NAME__ example: Setting SOAP_MaxRequests
<programlisting>
SOAP_MaxRequests 200
</programlisting>
__END__




1.1                  xmldocs/refs/SOAP_Perms


rev 1.1, prev_rev 1.0
Index: SOAP_Perms
===================================================================
__NAME__ purpose
Interchange SOAP-RPC Unix socket permissions
__END__

__NAME__ see also
SOAP
__END__


__NAME__ synopsis
<group choice='req'>
	<arg choice='plain'>mode</arg>
</group>
__END__


__NAME__ description
Specify permissions (&glos-mode;) for the Interchange 
&glos-SOAP-RPC; UNIX-domain socket.
</para><para>
Prepend a starting <literal>0</literal> to indicate an octal value.
</para><para>
The default value is <literal>0660</literal>, which allows only programs
running under your &IC; server UID or GID to access the socket.
__END__

__NAME__ notes
Although not recommended in practice, it sometimes makes sense to
set the permissions to <literal>0666</literal> (world-writable) to 
debug problems easier.
__END__


__NAME__ example: Setting SOAP_Perms
<programlisting>
SOAP_Perms 0666
</programlisting>
__END__




1.1                  xmldocs/refs/SOAP_Socket


rev 1.1, prev_rev 1.0
Index: SOAP_Socket
===================================================================
__NAME__ purpose
name of SOAP RPC socket files
__END__

__NAME__ see also
SOAP, SocketFile
__END__


__NAME__ synopsis
<group choice='req'>
	<arg choice='plain' rep='repeat'>filename_or_host:port</arg>
</group>
__END__


__NAME__ description
The directive specifies the Inet and Unix sockets &IC; should listen on
for &glos-SOAP-RPC; requests.
</para><para>
The list should be space-separated. Each entry is considered to be
an Unix socket if it contains "<literal>/</literal>" somewhere in its
path. Any other specification is considered an Inet socket, and can be 
in form of <literal><replaceable>NNN</replaceable>.<replaceable>NNN</replaceable>.<replaceable>NNN</replaceable>.<replaceable>NNN</replaceable>:<replaceable>PPPP</replaceable></literal>, where the IP address and the colon are optional.
</para><para>
The default value is Inet socket on port <literal>7780</literal>, if
&conf-SOAP; is enabled.
__END__

__NAME__ notes
__END__


__NAME__ example: Setting SOAP_Socket
<programlisting>
SOAP_Socket /var/run/interchange/interchange.soap
</programlisting>
__END__

__NAME__ example: Setting SOAP_Socket
<programlisting>
SOAP_Socket 12.23.13.31:7770 1.2.3.4:7770 /var/run/interchange/soap
</programlisting>
__END__




1.1                  xmldocs/refs/SOAP_StartServers


rev 1.1, prev_rev 1.0
Index: SOAP_StartServers
===================================================================
__NAME__ purpose
specify number of servers which should be started to handle SOAP RPC requests
__END__

__NAME__ see also
SOAP_Host, SOAP_Socket, SOAP_Perms, Soap_MaxRequests, SOAP_StartServers, StartServers
__END__

__NAME__ notes
__END__

__NAME__ synopsis
<group choice='req'>
	<arg choice='plain'><replaceable>count_less_than_51</replaceable></arg>
</group>
__END__


__NAME__ description
The directive specifies the number of servers which should be started
and handling &glos-SOAP-RPC; requests.
</para><para>
The default is <literal>1</literal>. Setting the directive to more than
<literal>50</literal> is unreasonable and produces an error.
__END__

__NAME__ example: Specifying SOAP_StartServers
<programlisting>
SOAP_StartServers 10
</programlisting>
__END__









More information about the docs mailing list