From 822be9f157e6a46cffc52bbdcc274bca38df1b72 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Roland=20H=C3=A4der?= Date: Tue, 21 Aug 2012 16:02:39 +0000 Subject: [PATCH] Added comments to explain messageData array --- .../class_AnnouncementAnswerOkayHandler.php | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/application/hub/main/handler/answer-status/announcement/class_AnnouncementAnswerOkayHandler.php b/application/hub/main/handler/answer-status/announcement/class_AnnouncementAnswerOkayHandler.php index c14b6c330..a148fee20 100644 --- a/application/hub/main/handler/answer-status/announcement/class_AnnouncementAnswerOkayHandler.php +++ b/application/hub/main/handler/answer-status/announcement/class_AnnouncementAnswerOkayHandler.php @@ -97,6 +97,17 @@ class AnnouncementAnswerOkayHandler extends BaseAnserStatusHandler implements Ha /** * Initializes configuration data from given message data array * + * The following array is being handled over: + * + * my-external-ip => 1.2.3.4 + * my-internal-ip => 5.6.7.8 + * my-status => reachable + * my-session-id => aaabbbcccdddeeefff123456789 + * my-tcp-port => 9060 + * my-udp-port => 9060 + * answer-status => OKAY + * message_type => announcement_answer + * * @param $messageData An array with all message data * @return void */ @@ -106,7 +117,7 @@ class AnnouncementAnswerOkayHandler extends BaseAnserStatusHandler implements Ha /** * Removes configuration data with given message data array from global - * configuration + * configuration. For content of $messageData see method comment above. * * @param $messageData An array with all message data * @return void -- 2.39.5