MagAOX::netcom::tunneledHost Class Reference

Contains the details of a tunneled-host specification and provides parsing. More...

#include <tunneledHost.hpp>

Collaboration diagram for MagAOX::netcom::tunneledHost:

Public Member Functions
std::string	name () const
	Get the host name. More...
int	name (const std::string &nn)
	Set the host name. More...
int	remotePort () const
	Get the remote port. More...
int	remotePort (const int &rp)
	Set the remote port. More...
int	localPort () const
	Get the localPort. More...
int	localPort (const int &lp)
	Set the local port. More...
std::string	remoteSpec ()
	Get the remote specification string, "name:remotePort". More...
std::string	fullSpec ()
	Get the full specification string, "name:remotePort:localPort". More...
int	parse (const std::string &cnws)
	Parse a host specification string into the component parts. More...

Protected Attributes
std::string	m_name
	The host name or ip address. More...
int	m_remotePort {INDI_DEFAULT_PORT}
	The remote port on the host. More...
int	m_localPort {0}
	The local port which will be forwarded. More...

Detailed Description

Contains the details of a tunneled-host specification and provides parsing.

Definition at line 26 of file tunneledHost.hpp.

Member Function Documentation

fullSpec()

std::string MagAOX::netcom::tunneledHost::fullSpec ( )

inline

Get the full specification string, "name:remotePort:localPort".

Returns

the full-spec as "name:remotePort:localPort"

Definition at line 111 of file tunneledHost.hpp.

localPort() [1/2]

int MagAOX::netcom::tunneledHost::localPort ( ) const

inline

Get the localPort.

Returns

the current value of m_localPort

Definition at line 79 of file tunneledHost.hpp.

localPort() [2/2]

int MagAOX::netcom::tunneledHost::localPort ( const int &  lp )

inline

Set the local port.

Returns

0 on sucess.

-1 on error.

Parameters

[in]

lp

the new local port

Definition at line 89 of file tunneledHost.hpp.

name() [1/2]

std::string MagAOX::netcom::tunneledHost::name ( ) const

inline

Get the host name.

Returns

the current value of m_name

Definition at line 39 of file tunneledHost.hpp.

name() [2/2]

int MagAOX::netcom::tunneledHost::name ( const std::string &  nn )

inline

Set the host name.

Returns

0 on sucess.

-1 on error.

Parameters

[in]

nn

the new name

Definition at line 49 of file tunneledHost.hpp.

parse()

int MagAOX::netcom::tunneledHost::parse ( const std::string &  cnws )

inline

Parse a host specification string into the component parts.

Expects a string in the form 'hostname[:remotePort]:localPort'. hostname and localPort are required. remotePort is optional, as the default INDI port of 7624 is assumed. Whitespace anywhere in the string is ignored. The ports are converted to integers.

Returns

0 on success

-1 on any error, in which case none of the values should be used.

Definition at line 130 of file tunneledHost.hpp.

remotePort() [1/2]

int MagAOX::netcom::tunneledHost::remotePort ( ) const

inline

Get the remote port.

Returns

the current value of m_remotePort

Definition at line 59 of file tunneledHost.hpp.

remotePort() [2/2]

int MagAOX::netcom::tunneledHost::remotePort ( const int &  rp )

inline

Set the remote port.

Returns

0 on sucess.

-1 on error.

Parameters

[in]

rp

the new remote port

Definition at line 69 of file tunneledHost.hpp.

remoteSpec()

std::string MagAOX::netcom::tunneledHost::remoteSpec ( )

inline

Get the remote specification string, "name:remotePort".

Returns

the remote-spec as "name:remotePort"

Definition at line 99 of file tunneledHost.hpp.

Member Data Documentation

m_localPort

int MagAOX::netcom::tunneledHost::m_localPort {0}

protected

The local port which will be forwarded.

Definition at line 32 of file tunneledHost.hpp.

Referenced by fullSpec(), localPort(), and parse().

m_name

std::string MagAOX::netcom::tunneledHost::m_name

protected

The host name or ip address.

Definition at line 30 of file tunneledHost.hpp.

Referenced by name().

m_remotePort

int MagAOX::netcom::tunneledHost::m_remotePort {INDI_DEFAULT_PORT}

protected

The remote port on the host.

Definition at line 31 of file tunneledHost.hpp.

Referenced by fullSpec(), parse(), remotePort(), and remoteSpec().

---

The documentation for this class was generated from the following file:

• /home/jrmales/Source/MagAOX/libMagAOX/netcom/tunneledHost.hpp