Changeset 9307 in orxonox.OLD

Timestamp:

Jul 17, 2006, 2:39:18 PM (18 years ago)

Author:

bensch

Message:

comments

Location:

branches/proxy/src/lib

Files:

• network/ip.cc (modified) (13 diffs)
• network/ip.h (modified) (1 diff)
• util/executor/functor_list.h (modified) (1 diff)

branches/proxy/src/lib/network/ip.cc

@@ -10 +10 @@
 #include "substring.h"
 
+/**
+ * @brief default constructor
+ */
 IP::IP()
 {
@@ -17 +20 @@
 
 
+/**
+ * @brief constructor from ip and port
+ * @param ip the IP
+ * @param port the Port
+ * @return self
+ */
 IP::IP(int ip, int port)
 {
@@ -25 +34 @@
 
 
+/**
+ * @brief constructor from a String
+ * @param ip the IP as a String.
+ * @return self
+ */
 IP::IP(const std::string& ip)
 {
@@ -31 +45 @@
 
 
+/**
+ * @brief constructor from an SDL net structure IPaddress
+ * @param ip the ip.
+ * @return self
+ */
 IP::IP(const IPaddress& ip)
 {
@@ -38 +57 @@
 
 
+/**
+ * @brief copy constructor.
+ * @param ip the IP to copy.
+ * @return self
+ */
 IP::IP(const IP& ip)
 {
@@ -46 +70 @@
 
 
+/**
+ * @brief copy operator
+ * @param ip the IP to copy.
+ * @return self.
+ */
 const IP& IP::operator=(const IP& ip)
 {
@@ -55 +84 @@
 
 
+/**
+ * @brief comparison operator
+ * @param ip the IP to compare
+ * @return true if ip _and_ port match.
+ */
 bool IP::operator==(const IP& ip)
 {
@@ -62 +96 @@
 
 /**
- * @returns The retrieved IP
- *
+ * @brief converts a String into an IP Object.
+ * @param ip The string holding an IP.
+ * @return a constructed IP.
  */
 IP IP::stringToIP(const std::string& ip)
@@ -85 +120 @@
 }
 
+
+/**
+ * @brief if you want to have a specific part of an IP
+ * @param part the n'th part of the IP addr (splitted by '.').
+ * @return the amount held in the designated part.
+ */
 int IP::ipPart(unsigned int part) const
 {
@@ -104 +145 @@
 
 
+/**
+ * @return the Ip as a string.
+ */
 std::string IP::ipString() const
 {
@@ -110 +154 @@
 
 
+/**
+ * @brief converts an IPaddress struct into a String.
+ * @param ipaddr the IP address as a SDL_net struct.
+ * @return the string retrieved from the IP.
+ */
 std::string IP::ipToString(const IPaddress& ipaddr)
 {
   int ip = SDLNet_Read32 (ipaddr.host);
-  return ipToString(ip);
+  return ipToString(ip, ipaddr.port);
 }
 
@@ -120 +169 @@
 
 
-std::string IP::ipToString(int ip)
+/**
+ * converts a IP into a String (without port).
+ * @param ip the IP to put into the string.
+ * @param port -1 if not wanted
+ * @return the string of the ip.
+ */
+std::string IP::ipToString(int ip, int port)
 {
   MultiType part0((int) (ip & 0xFF000000) >> 24);
@@ -127 +182 @@
   MultiType part3((int) (ip & 0x000000FF) );
 
+  std::string addr = part0.getString() + "." + part1.getString() + "." +
+                     part2.getString() + "." + part3.getString();
 
-  return part0.getString() + "." + part1.getString() + "." +
-         part2.getString() + "." + part3.getString();
+  if (port != -1)
+    addr += MultiType(port).getString();
+  return addr;
 }
 

branches/proxy/src/lib/network/ip.h

@@ -43 +43 @@
 
     static std::string ipToString(const IPaddress& ipaddr);
-    static std::string ipToString(int ip);
+    static std::string ipToString(int ip, int port = -1);
 
   private:

branches/proxy/src/lib/util/executor/functor_list.h

@@ -135 +135 @@
 
   //! mixed values:
+  FUNCTOR_LIST(2)(l_STRING, l_INT);
   FUNCTOR_LIST(2)(l_STRING, l_FLOAT);
   FUNCTOR_LIST(2)(l_UINT, l_LONG);