Rombobjörn

summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBjörn Persson <bjorn@rombobjörn.se>2013-08-16 01:12:42 +0200
committerBjörn Persson <bjorn@rombobjörn.se>2013-08-16 01:12:42 +0200
commita3ee6036e606682587d52b6f70af9d1b4958b302 (patch)
treec11d325aaaa2f6523f8ebbe17a0cce7763f7b8b5
parented061ef007de3c94fdbb38ce1b0a9fd8225a04a2 (diff)
Completed some subprogram descriptions.
-rw-r--r--milter_api.ads12
1 files changed, 7 insertions, 5 deletions
diff --git a/milter_api.ads b/milter_api.ads
index 78dfe80..d8ced57 100644
--- a/milter_api.ads
+++ b/milter_api.ads
@@ -393,7 +393,7 @@ package Milter_API is
Unknown_Address_Type : exception;
-- A Sockaddr handle that pointed to something other than an IPv4 or IPv6
- -- address was passed to Address or Port.
+ -- endpoint was passed to Address or Port.
--
@@ -524,16 +524,18 @@ package Milter_API is
function Address(Endpoint : Sockaddr) return IP_Address;
-- Returns the IP address from a Sockaddr handle, or raises No_Address if
- -- the handle doesn't point to anything.
+ -- the handle doesn't point to anything, or raises Unknown_Address_Type if
+ -- the handle points to something other than an IPv4 or IPv6 endpoint.
function Address(Endpoint : Sockaddr) return String;
-- Returns the textual representation of the IP address from a Sockaddr
- -- handle, or returns "(address unavailable)" if the handle doesn't point to
- -- anything.
+ -- handle, or returns an error message in parentheses if the conversion
+ -- fails for any reason.
function Port(Endpoint : Sockaddr) return Interfaces.Unsigned_16;
-- Returns the TCP port from a Sockaddr handle, or raises No_Address if the
- -- handle doesn't point to anything.
+ -- handle doesn't point to anything, or raises Unknown_Address_Type if the
+ -- handle points to something other than an IPv4 or IPv6 endpoint.
--