-// ANNA - Anna is Not 'N' Anymore
-//
-// (c) Copyright 2005-2014 Eduardo Ramos Testillano & Francisco Ruiz Rayo
-//
-// https://bitbucket.org/testillano/anna
-//
-// Redistribution and use in source and binary forms, with or without
-// modification, are permitted provided that the following conditions
-// are met:
-//
-// * Redistributions of source code must retain the above copyright
-// notice, this list of conditions and the following disclaimer.
-// * Redistributions in binary form must reproduce the above
-// copyright notice, this list of conditions and the following disclaimer
-// in the documentation and/or other materials provided with the
-// distribution.
-// * Neither the name of Google Inc. nor the names of its
-// contributors may be used to endorse or promote products derived from
-// this software without specific prior written permission.
-//
-// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
-// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
-// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
-// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
-// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
-// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
-// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
-// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-//
-// Authors: eduardo.ramos.testillano@gmail.com
-// cisco.tierra@gmail.com
+// ANNA - Anna is Not Nothingness Anymore //
+// //
+// (c) Copyright 2005-2015 Eduardo Ramos Testillano & Francisco Ruiz Rayo //
+// //
+// See project site at http://redmine.teslayout.com/projects/anna-suite //
+// See accompanying file LICENSE or copy at http://www.teslayout.com/projects/public/anna.LICENSE //
#ifndef anna_comm_INetAddress_hpp
class Device;
/**
- Abstraccion de direcciones de red.
-
- Facilita el uso de las direcciones de red.
+ Network address abstraction.
*/
class INetAddress {
public:
/**
Constructor.
- \param device Instancia del dispositivo.
- \param port Numero de puerto.
+ \param device Instance for device (address).
+ \param port Port number.
*/
INetAddress(const Device* device, const int port = -1) : a_device(device), a_port(port) {;}
/**
- Constructor copia.
- \param other Direccin IP de la que obtener la informacin.
+ Copy constructor.
+ \param other Source network address.
*/
INetAddress(const INetAddress& other) : a_device(other.a_device) , a_port(other.a_port) {;}
/**
- Devuelve la direccion asociada a esta instancia.
- \param exceptionWhenNull Indica si debemos lanzar una excepcion en caso de que el dispositivo
- asociado sea NULL.
- \return La direccion asociada a esta instancia.
+ Returns the device (address) associated to this instance.
+ \param exceptionWhenNull Exception is launched in case the device returned is NULL.
+ \return Device (address) associated to this instance.
*/
const Device* getDevice(const bool exceptionWhenNull = true) const throw(RuntimeException);
/**
- Devuelve el puerto asociada a esta instancia.
- \return El puerto asociada a esta instancia.
+ Returns the port associated to this instance.
+ \return Port associated to this instance.
*/
int getPort() const throw() { return a_port; }
/**
- Establece la direccion IP correspondiente a este objeto.
- \param device Dispositivo de red asociado a este objeto.
+ Sets the address for this instance.
+ \param device Address provided.
*/
void setAddress(const Device* device) throw() { a_device = device; }
/**
- Establece el puerto correspondiente a este objeto.
- \param port Numero de puerto correspondiente a este objeto.
+ Sets the port for this instance.
+ \param port Port provided.
*/
void setPort(const int port) throw() { a_port = port; }
/**
- Operador copia.
- \param right Direccin IP de la que obtener la informacin.
+ Copy operator.
+ \param right Source address to be copied.
*/
INetAddress& operator = (const INetAddress& right) throw() { a_device = right.a_device; a_port = right.a_port; return *this; }
/**
- Operador de comparacion.
- \param right Direccion con la comparar.
- @return \em true si la direccion recibida como parametro coincide con esta.
- \em false en otro caso.
+ Comparison operator.
+ \param right Source address to be compared.
+ @return \em true when address provided is equal to this \em false in other case.
*/
bool operator == (const INetAddress& right) const throw() { return a_device == right.a_device && a_port == right.a_port; }
/**
- Devuelve el estado de inicializacin de esta direccin de red.
- @return \em true si no ha sido inicializa o \em false en otro caso.
+ Returns the initialized state for this network address.
+ @return \em true when initialized, \em false when not.
*/
bool isNull() const throw() { return (a_device == NULL || a_port == -1); }
/**
- Elimina el contenido de esta instancia.
+ Clear the content for this instance.
*/
void clear() throw() { a_device = NULL; a_port = -1; }
/**
- Devuelve una cadena la informacion mas relevante de esta instancia.
- @return Una cadena la informacion mas relevante de esta instancia.
+ Returns string with relevant information for this instance.
+ @return string with relevant information for this instance.
*/
std::string asString() const throw();
/**
- Devuelve una cadena la informacion mas relevante de esta instancia en formato de bajo nivel.
- @return Una cadena la informacion mas relevante de esta instancia en formato de bajo nivel.
+ Returns string with low-level format relevant information for this instance.
+ @return string with low-level format relevant information for this instance.
*/
std::string serialize() const throw();
/**
- Devuelve un documento XML con la informacion mas relevante de esta instancia.
- \param parent Nodo XML del que deben depender los datos a crear.
- @return Un documento XML con la informacion mas relevante de esta instancia.
+ Returns XML document with relevant information for this instance.
+ \param parent XML node from which created data will depend on.
+ @return XML document with relevant information for this instance.
*/
xml::Node* asXML(xml::Node* parent) const throw(RuntimeException);