Logo AND Algorithmique Numérique Distribuée

Public GIT Repository
New function: gras_agent_spawn
[simgrid.git] / examples / gras / ping / ping.c
index dc2e81b..5095e30 100644 (file)
-/* $Id$ */
+#include "ping.h"
 
-/* ping - ping/pong demo of GRAS features                                   */
-
-/* Copyright (c) 2003, 2004, 2005 Martin Quinson. All rights reserved.      */
-
-/* This program is free software; you can redistribute it and/or modify it
- * under the terms of the license (GNU LGPL) which comes with this package. */
-
-#include "gras.h"
 
 XBT_LOG_NEW_DEFAULT_CATEGORY(Ping,"Messages specific to this example");
 
-/* **********************************************************************
- * Comon code
- * **********************************************************************/
-
-static void register_messages(void) {
-  gras_msgtype_declare("ping", gras_datadesc_by_name("int"));
-  gras_msgtype_declare("pong", gras_datadesc_by_name("int"));
-}
-
-/* **********************************************************************
- * Server code
- * **********************************************************************/
-
 /* Global private data */
 typedef struct {
   gras_socket_t sock;
   int endcondition;
 } server_data_t;
 
-/* Function prototypes */
-int server_cb_ping_handler(gras_socket_t  expeditor,
-                          void          *payload_data);
-int server (int argc,char *argv[]);
 
+/* register messages which may be sent (common to client and server) */
+void ping_register_messages(void) {
+  gras_msgtype_declare("ping", gras_datadesc_by_name("int"));
+  gras_msgtype_declare("pong", gras_datadesc_by_name("int"));
+  INFO0("Messages registered");
+}
 
-int server_cb_ping_handler(gras_socket_t  expeditor,
-                          void          *payload_data) {
+static int server_cb_ping_handler(gras_msg_cb_ctx_t ctx, void* payload) {
                             
-  xbt_error_t errcode;
-  int msg=*(int*)payload_data;
+  xbt_ex_t e;
+  /* 1. Get the payload into the msg variable, and retrieve my caller */
+  int msg=*(int*)payload;
+  gras_socket_t expeditor = gras_msg_cb_ctx_from(ctx);
 
-  server_data_t *globals=(server_data_t*)gras_userdata_get();
+  /* 2. Retrieve the server's state (globals) */
 
+  server_data_t *globals=(server_data_t*)gras_userdata_get();
   globals->endcondition = 0;
-  INFO3("SERVER: >>>>>>>> Got message PING(%d) from %s:%d <<<<<<<<", 
+   
+  /* 3. Log which client connected */
+  INFO3(">>>>>>>> Got message PING(%d) from %s:%d <<<<<<<<", 
        msg, 
        gras_socket_peer_name(expeditor), gras_socket_peer_port(expeditor));
   
+  /* 4. Change the value of the msg variable */
   msg = 4321;
-  errcode = gras_msg_send(expeditor, gras_msgtype_by_name("pong"), &msg);
+  /* 5. Send it back as payload of a pong message to the expeditor */
+  TRY {
+    gras_msg_send(expeditor, "pong", &msg);
 
-  if (errcode != no_error) {
-    ERROR1("SERVER: Unable answer with PONG: %s\n", xbt_error_name(errcode));
+  /* 6. Deal with errors: add some details to the exception */
+  } CATCH(e) {
     gras_socket_close(globals->sock);
-    return 1;
+    RETHROW0("Unable answer with PONG: %s");
   }
 
-  INFO0("SERVER: >>>>>>>> Answed with PONG(4321) <<<<<<<<");
+  INFO0(">>>>>>>> Answered with PONG(4321) <<<<<<<<");
+   
+  /* 7. Set the endcondition boolean to true (and make sure the server stops after receiving it). */
   globals->endcondition = 1;
+  
+  /* 8. Make sure we don't leak sockets */
   gras_socket_close(expeditor);
-  return 1;
-}
+   
+  /* 9. Tell GRAS that we consummed this message */
+  return 0;
+} /* end_of_server_cb_ping_handler */
 
 int server (int argc,char *argv[]) {
-  xbt_error_t errcode;
   server_data_t *globals;
 
   int port = 4000;
   
-  gras_init(&argc,argv, NULL);
+  /* 1. Init the GRAS infrastructure and declare my globals */
+  gras_init(&argc,argv);
   globals=gras_userdata_new(server_data_t);
    
+  /* 2. Get the port I should listen on from the command line, if specified */
   if (argc == 2) {
     port=atoi(argv[1]);
   }
 
   INFO1("Launch server (port=%d)", port);
 
-  if ((errcode=gras_socket_server(port,&(globals->sock)))) { 
-    CRITICAL1("Error %s encountered while opening the server socket",
-             xbt_error_name(errcode));
-    return 1;
-  }
+  /* 3. Create my master socket */
+  globals->sock = gras_socket_server(port);
 
-  register_messages();
-  register_messages();
-  gras_cb_register(gras_msgtype_by_name("ping"),&server_cb_ping_handler);
+  /* 4. Register the known messages. This function is called twice here, but it's because
+        this file also acts as regression test, no need to do so yourself of course. */
+  ping_register_messages();
+  ping_register_messages(); /* just to make sure it works ;) */
+   
+  /* 5. Register my callback */
+  gras_cb_register("ping",&server_cb_ping_handler);
 
-  INFO1("SERVER: >>>>>>>> Listening on port %d <<<<<<<<",
-       gras_socket_my_port(globals->sock));
+  INFO1(">>>>>>>> Listening on port %d <<<<<<<<", gras_socket_my_port(globals->sock));
   globals->endcondition=0;
 
-  errcode = gras_msg_handle(600.0);
-  if (errcode != no_error)
-    return errcode;
+  /* 6. Wait up to 10 minutes for an incomming message to handle */
+  gras_msg_handle(60.0);
+   
+  /* 7. Housekeeping */
   if (!globals->endcondition)
      WARN0("An error occured, the endcondition was not set by the callback");
   
-  if (!gras_if_RL())
-    gras_os_sleep(1,0);
-
+  /* 8. Free the allocated resources, and shut GRAS down */
   gras_socket_close(globals->sock);
   free(globals);
   gras_exit();
-  INFO0("SERVER: Done.");
-  return no_error;
-}
-
-/* **********************************************************************
- * Client code
- * **********************************************************************/
+   
+  INFO0("Done.");
+  return 0;
+} /* end_of_server */
 
-/* Function prototypes */
-int client (int argc,char *argv[]);
 
 int client(int argc,char *argv[]) {
-  xbt_error_t errcode; 
-  gras_socket_t toserver; /* peer */
+  xbt_ex_t e; 
+  gras_socket_t toserver=NULL; /* peer */
 
   gras_socket_t from;
   int ping, pong;
@@ -126,54 +115,65 @@ int client(int argc,char *argv[]) {
   const char *host = "127.0.0.1";
         int   port = 4000;
 
-  gras_init(&argc, argv, NULL);
+  /* 1. Init the GRAS's infrastructure */
+  gras_init(&argc, argv);
    
+  /* 2. Get the server's address. The command line override defaults when specified */
   if (argc == 3) {
     host=argv[1];
     port=atoi(argv[2]);
   } 
 
   INFO2("Launch client (server on %s:%d)",host,port);
-  gras_os_sleep(1,0); /* Wait for the server startup */
-  if ((errcode=gras_socket_client(host,port,&toserver))) {
-    ERROR1("Client: Unable to connect to the server. Got %s",
-          xbt_error_name(errcode));
-    return 1;
+   
+  /* 3. Wait for the server startup */
+  gras_os_sleep(1);
+   
+  /* 4. Create a socket to speak to the server */
+  TRY {
+    toserver=gras_socket_client(host,port);
+  } CATCH(e) {
+    RETHROW0("Unable to connect to the server: %s");
   }
-  INFO2("Client: Connected to %s:%d.",host,port);    
+  INFO2("Connected to %s:%d.",host,port);    
 
 
-  register_messages();
+  /* 5. Register the messages. 
+        See, it doesn't have to be done completely at the beginning, only before use */
+  ping_register_messages();
 
-  INFO2("Client: >>>>>>>> Connected to server which is on %s:%d <<<<<<<<", 
+  /* 6. Keep the user informed of what's going on */
+  INFO2(">>>>>>>> Connected to server which is on %s:%d <<<<<<<<", 
        gras_socket_peer_name(toserver),gras_socket_peer_port(toserver));
 
+  /* 7. Prepare and send the ping message to the server */
   ping = 1234;
-  errcode = gras_msg_send(toserver, gras_msgtype_by_name("ping"), &ping);
-  if (errcode != no_error) {
-    fprintf(stderr, "Client: Unable send PING to server (%s)\n",
-           xbt_error_name(errcode));
+  TRY {
+    gras_msg_send(toserver, "ping", &ping);
+  } CATCH(e) {
     gras_socket_close(toserver);
-    return 1;
+    RETHROW0("Failed to send PING to server: %s");
   }
-  INFO3("Client: >>>>>>>> Message PING(%d) sent to %s:%d <<<<<<<<",
+  INFO3(">>>>>>>> Message PING(%d) sent to %s:%d <<<<<<<<",
        ping,
        gras_socket_peer_name(toserver),gras_socket_peer_port(toserver));
 
-  if ((errcode=gras_msg_wait(6000,gras_msgtype_by_name("pong"),
-                            &from,&pong))) {
-    ERROR1("Client: Why can't I get my PONG message like everyone else (%s)?",
-          xbt_error_name(errcode));
+  /* 8. Wait for the answer from the server, and deal with issues */
+  TRY {
+    gras_msg_wait(6000,"pong", &from,&pong);
+  } CATCH(e) {
     gras_socket_close(toserver);
-    return 1;
+    RETHROW0("Why can't I get my PONG message like everyone else: %s");
   }
 
-  INFO3("Client: >>>>>>>> Got PONG(%d) got from %s:%d <<<<<<<<", 
+  /* 9. Keep the user informed of what's going on, again */
+  INFO3(">>>>>>>> Got PONG(%d) from %s:%d <<<<<<<<", 
        pong,
        gras_socket_peer_name(from),gras_socket_peer_port(from));
 
+  /* 10. Free the allocated resources, and shut GRAS down */
   gras_socket_close(toserver);
   gras_exit();
-  INFO0("Client: Done.");
+  INFO0("Done.");
   return 0;
-}
+} /* end_of_client */