[svn:parrot] r40393 - trunk/src/pmc

[tene at svn.parrot.org]

Author: tene
Date: Mon Aug  3 15:20:49 2009
New Revision: 40393
URL: https://trac.parrot.org/parrot/changeset/40393

Log:
Add a poll method to Socket.pmc
Add function signatures to the POD for Socket methods.

Modified:
   trunk/src/pmc/socket.pmc

Modified: trunk/src/pmc/socket.pmc
==============================================================================
--- trunk/src/pmc/socket.pmc	Mon Aug  3 05:19:22 2009	(r40392)
+++ trunk/src/pmc/socket.pmc	Mon Aug  3 15:20:49 2009	(r40393)
@@ -144,7 +144,7 @@
 
 =over 4
 
-=item C<socket>
+=item C<socket(INTVAL fam, INTVAL type, INTVAL proto)>
 
 =cut
 
@@ -159,7 +159,25 @@
 
 /*
 
-=item C<sockaddr>
+=item C<poll(INTVAL which, INTVAL sec, INTVAL usec)>
+
+Watches the socket for C<sec> seconds and C<usec> milliseconds.  C<which>
+is a bitmask representing the states you want to watch for.  Or together 1
+for readable, two for writeable, and four for exceptions.
+
+=cut
+
+*/
+
+
+    METHOD poll(INTVAL which, INTVAL sec, INTVAL usec) {
+        INTVAL poll = Parrot_io_poll(INTERP, SELF, which, sec, usec);
+        RETURN(INTVAL poll);
+    }
+
+/*
+
+=item C<sockaddr(STRING * address, INTVAL port)>
 
 C<sockaddr> returns an object representing a socket address, generated
 from a port number (integer) and an address (string).
@@ -175,7 +193,7 @@
 
 /*
 
-=item C<connect>
+=item C<connect(PMC * address)>
 
 Connects a socket object to an address.
 
@@ -197,7 +215,7 @@
 
 /*
 
-=item C<close>
+=item C<close()>
 
 Close a socket.
 
@@ -219,7 +237,7 @@
 
 /*
 
-=item C<recv>
+=item C<recv()>
 
 Receives a message from a connected socket object. It returns
 the message in a string.
@@ -241,7 +259,7 @@
 
 /*
 
-=item C<send>
+=item C<send(STRING *buf)>
 
 Sends a message string to a connected socket object.
 
@@ -260,7 +278,7 @@
 
 /*
 
-=item C<bind>
+=item C<bind(PMC *host)>
 
 C<bind> binds a socket object to the port and address specified by an
 address object (the packed result of C<sockaddr>).
@@ -283,7 +301,7 @@
 
 /*
 
-=item C<listen>
+=item C<listen(INTVAL backlog)>
 
 C<listen> specifies that a socket object is willing to accept incoming
 connections. The integer argument gives the maximum size of the queue
@@ -303,7 +321,7 @@
 
 /*
 
-=item C<accept>
+=item C<accept()>
 
 C<accept> accepts a new connection on a given socket object, and returns
 a newly created socket object for the connection.