ossimToolClient Class Reference

Utility class providing an interface to ossimTool-derived functionality via TCP sockets Results are returned either as streamed text (for non-image responses such as image info) or streamed binary file representing imagery or vector products. More...

#include <ossimToolClient.h>

Public Member Functions
	ossimToolClient ()
	~ossimToolClient ()
	Closes any open connections. More...
int	connectToServer (char *hostname, char *portname=NULL)
	Accepts hostname and portname as a string. More...
bool	setProductFilePath (const char *filepath)
	Sets the local destination directory for file product. More...
const char *	getProductFilePath () const
	Returns the filename (including full client-side path) of the local product file waiting after execute(), or NULL if none. More...
bool	execute (const char *command_spec)
	Executes OSSIM tool command with options. More...
const char *	getTextResponse () const
	Returns the server's text response generated by the execute() call, or NULL if no response available. More...
bool	disconnect ()
	Closes connection to server and ready to connect again. More...

Protected Member Functions
void	error (const char *msg)
bool	receiveText ()
bool	receiveFile ()
bool	acknowledgeRcv ()

Protected Attributes
int	m_svrsockfd
char *	m_buffer
ossimFilename	m_prodFilePath
ossimString	m_textResponse

Detailed Description

Utility class providing an interface to ossimTool-derived functionality via TCP sockets Results are returned either as streamed text (for non-image responses such as image info) or streamed binary file representing imagery or vector products.

Code interfacing to this class should know the commands available (or execute the command "help" and view the text response).

Definition at line 20 of file ossimToolClient.h.

Constructor & Destructor Documentation

ossimToolClient()

ossimToolClient::ossimToolClient

(

)

Definition at line 31 of file ossimToolClient.cpp.

References m_buffer, MAX_BUF_LEN, and setProductFilePath().

:  m_svrsockfd(-1),
   m_buffer(new char[MAX_BUF_LEN])
{
   ossimFilename tmpdir = "/tmp";
#ifdef _MSC_VER
   if (GetTempPath(MAX_BUF_LEN, m_buffer))
      tmpdir = m_buffer;
#endif
   setProductFilePath(tmpdir);
}

~ossimToolClient()

ossimToolClient::~ossimToolClient

(

)

Closes any open connections.

Definition at line 43 of file ossimToolClient.cpp.

References disconnect().

{
   disconnect();
}

Member Function Documentation

acknowledgeRcv()

bool ossimToolClient::acknowledgeRcv ( )

protected

Definition at line 288 of file ossimToolClient.cpp.

References _DEBUG_, error(), and m_svrsockfd.

Referenced by receiveFile(), and receiveText().

{
   if (_DEBUG_) cout<<"ossimToolClient:"<<__LINE__<<" sending \"ok_to_send\"..."<<endl; //TODO REMOVE DEBUG
   int r = send(m_svrsockfd, "ok_to_send", 11, 0);
   if (r < 0)
   {
      error("ERROR writing to socket");
      return false;
   }
   if (_DEBUG_) cout << "Receive acknowledged."<<endl;
   return true;
}

connectToServer()

int ossimToolClient::connectToServer	(	char *	hostname,
		char *	portname = NULL
	)

Accepts hostname and portname as a string.

Returns socket file descriptor or -1 if error.

Definition at line 73 of file ossimToolClient.cpp.

References ossimString::after(), ossimString::before(), ossimString::contains(), disconnect(), ossimString::empty(), error(), if(), m_svrsockfd, and ossimString::stringDup().

{
   m_svrsockfd = -1;
   while (1)
   {
      // Consider port number in host URL:
      ossimString host (hostname);
      ossimString port;
      if (portname)
         port = portname;
      else if (host.contains(":"))
      {
         port = host.after(":");
         host = host.before(":");
      }

      if (port.empty())
      {
         // Maybe implied port then '/':
         port = host.after("/");
         port = "/" + port;
         host = host.before("/");
      }

      // Establish full server address including port:
      struct addrinfo hints;
      memset(&hints, 0, sizeof hints); // make sure the struct is empty
      hints.ai_family = AF_INET;     // don't care IPv4 or IPv6
      hints.ai_socktype = SOCK_STREAM; // TCP stream sockets
      hints.ai_canonname = host.stringDup();     // fill in my IP for me
      struct addrinfo *res;
      int failed = getaddrinfo(host.stringDup(), port.stringDup(), &hints, &res);
      if (failed)
      {
         error(gai_strerror(failed));
         break;
      }

      // Create socket for this server by walking the linked list of available addresses:
      struct addrinfo *server_info = res;
      while (server_info)
      {
         m_svrsockfd =
               socket(server_info->ai_family, server_info->ai_socktype, server_info->ai_protocol);
         if (m_svrsockfd >= 0)
            break;
         server_info = server_info->ai_next;
      }
      if ((m_svrsockfd < 0) || (server_info == NULL))
      {
         error("Error opening socket");
         break;
      }

      // Connect to the server:portno:
      struct sockaddr_in* serv_addr = (sockaddr_in*) server_info->ai_addr;
      serv_addr->sin_family = AF_INET;
      if (connect(m_svrsockfd,(struct sockaddr*) serv_addr, server_info->ai_addrlen) < 0)
      {
         error("ERROR connecting");
         disconnect();
      }

      break;
   }
   return m_svrsockfd;
}

disconnect()

bool ossimToolClient::disconnect

(

)

Closes connection to server and ready to connect again.

Definition at line 48 of file ossimToolClient.cpp.

References error(), and m_svrsockfd.

Referenced by connectToServer(), and ~ossimToolClient().

{
   bool success = true;

   if (m_svrsockfd < 0)
      return success;

   // Need to send close request to server:
   if (close(m_svrsockfd) < 0)
   {
      error("Error closing socket");
      success = false;
   }

   m_svrsockfd = -1;
   return success;
}

error()

void ossimToolClient::error ( const char *  msg )

protected

Definition at line 67 of file ossimToolClient.cpp.

Referenced by acknowledgeRcv(), connectToServer(), disconnect(), execute(), receiveFile(), receiveText(), and setProductFilePath().

{
   perror(msg);
}

execute()

bool ossimToolClient::execute

(

const char *

command_spec

)

Executes OSSIM tool command with options.

Examples:

"info -p <server-side-filename>" – Fetches projection info for server side file specified "shoreline -i <server/path/band3.tif>, <server/path/band6.tif> <server/path/output.json>"

Returns TRUE if product generated and received. setProductFilePath() must be called prior to execute() for operations generating file products, otherwise the products are written to the client's temp directory.

Definition at line 142 of file ossimToolClient.cpp.

References _DEBUG_, ossimString::contains(), error(), ossimFilename::isDir(), m_buffer, m_prodFilePath, m_svrsockfd, MAX_BUF_LEN, n, ossimFilename::path(), receiveFile(), and receiveText().

{
   // Clear previous file path of product filename:
   if (!m_prodFilePath.isDir())
      m_prodFilePath =m_prodFilePath.path();

   if (command_spec == NULL)
      return false;

   // Write command to the OSSIM tool server socket:
   if (_DEBUG_) cout<<"ossimToolClient:"<<__LINE__<<" sending <"<<command_spec<<">..."<<endl; //TODO REMOVE DEBUG
   int n = send(m_svrsockfd, command_spec, strlen(command_spec), 0);
   if (n < 0)
   {
      error("ERROR writing to socket");
      return false;
   }
   while (n < (int) strlen(command_spec))
   {
      // Partial send, try remainder of buffer:
      if (_DEBUG_) cout<<"ossimToolClient:"<<__LINE__<<" sending <"<<&(command_spec[n])<<">..."<<endl; //TODO REMOVE DEBUG
      int r = send(m_svrsockfd, &(command_spec[n]), strlen(command_spec)-n, 0);
      if (r < 0)
      {
         error("ERROR writing to socket");
         return false;
      }
      n += r;
   }

   // Process response from server. First read the response type. Can be either:
   //     "TEXT"  -- only text is streamed
   //     "FILE"  -- a file is treamed
   //     "MIXED" -- Both file and text
   //     "ERROR" -- only text with error message. No product generated.
   //     "ADIOS" -- Server acknowledges disconnect
   bool success = false;
   memset(m_buffer, 0, MAX_BUF_LEN);
   if (_DEBUG_) cout<<"ossimToolClient:"<<__LINE__<<" Waiting to recv"<<endl; //TODO REMOVE DEBUG
   n = recv(m_svrsockfd, m_buffer, 5, 0);
   if (_DEBUG_) cout<<"ossimToolClient:"<<__LINE__<<" Received <"<<m_buffer<<">"<<endl; //TODO REMOVE DEBUG
   if (n < 0)
   {
      error("ERROR reading from socket");
      return false;
   }
   ossimString response (string(m_buffer, n));
   if (response.contains("TEXT"))
      success = receiveText();
   else if (response.contains("FILE"))
      success = receiveFile();
   else if (response.contains("MIXED"))
      success = receiveText() && receiveFile();
   else if (response.contains("ERROR"))
      receiveText(); // success = false;
   else if (response.contains("ADIOS"))
      error("Received unexpected disconnect message from server.");
   else
      error("Unknown type in response header");

   return success;
}

getProductFilePath()

const char* ossimToolClient::getProductFilePath ( ) const

inline

Returns the filename (including full client-side path) of the local product file waiting after execute(), or NULL if none.

Definition at line 49 of file ossimToolClient.h.

{ return m_prodFilePath; }

getTextResponse()

const char* ossimToolClient::getTextResponse ( ) const

inline

Returns the server's text response generated by the execute() call, or NULL if no response available.

Some operations generate both text and file products.

Definition at line 67 of file ossimToolClient.h.

{ return m_textResponse.chars(); }

receiveFile()

bool ossimToolClient::receiveFile ( )

protected

Definition at line 231 of file ossimToolClient.cpp.

References acknowledgeRcv(), ossimString::after(), ossimString::chars(), ossimFilename::dirCat(), error(), m_buffer, m_prodFilePath, m_svrsockfd, m_textResponse, MAX_BUF_LEN, n, receiveText(), and ossimString::toInt().

Referenced by execute().

{
   ostringstream xmsg;
   cout << "Server requesting file send. " <<endl;

   // Fetch the file size in bytes as the next message "SIZE: GGGMMMKKKBBB", (18 bytes)
   if (!receiveText())
      return false;
   int filesize = m_textResponse.after("SIZE: ").toInt();
   cout << "File size = " <<filesize<<endl;

   // Fetch the filename as next message "NAME: AAAAA...", (256 bytes)
   if (!receiveText())
      return false;
   ossimFilename fileName (m_textResponse.after("NAME: "));
   m_prodFilePath = m_prodFilePath.dirCat(fileName);
   cout << "File name = " <<m_prodFilePath<<endl;

   // Open file for writing:
   ofstream fout (m_prodFilePath.chars());
   if (fout.fail())
   {
      xmsg <<"ERROR opening output file: <"<<m_prodFilePath<<">"<<ends;
      error(xmsg.str().c_str());
      return false;
   }

   memset(m_buffer, 0, MAX_BUF_LEN);
   int n = MAX_BUF_LEN;
   int numBytes = 0;
   while ((n == MAX_BUF_LEN) && (numBytes < filesize))
   {
      n = recv(m_svrsockfd, m_buffer, MAX_BUF_LEN, 0);
      if (n < 0)
      {
         error("ERROR reading from socket");
         return false;
      }
      fout.write(m_buffer, n);
      if (fout.fail())
      {
         error("ERROR on file write().");
         return false;
      }
      numBytes += n;
   }

   if (!acknowledgeRcv())
      return false;

   cout<<"\nossim-client: Received and wrote "<<numBytes<<" bytes to: <"<<m_prodFilePath<<">."<<endl;;
   fout.close();

   return true;
}

receiveText()

bool ossimToolClient::receiveText ( )

protected

Definition at line 206 of file ossimToolClient.cpp.

References _DEBUG_, acknowledgeRcv(), ossimString::append(), ossimString::c_str(), ossimString::clear(), error(), m_buffer, m_svrsockfd, m_textResponse, MAX_BUF_LEN, and n.

Referenced by execute(), and receiveFile().

{
   int n = MAX_BUF_LEN;
   m_textResponse.clear();
   while (n == MAX_BUF_LEN)
   {
      memset(m_buffer, 0, MAX_BUF_LEN);
      if (_DEBUG_) cout<<"ossimToolClient:"<<__LINE__<<" Waiting to recv"<<endl; //TODO REMOVE DEBUG
      n = recv(m_svrsockfd, m_buffer, MAX_BUF_LEN, 0);
      if (_DEBUG_) cout<<"ossimToolClient:"<<__LINE__<<" Received <"<<m_buffer<<">"<<endl; //TODO REMOVE DEBUG
      if (n < 0)
      {
         error("ERROR reading from socket");
         return false;
      }
      m_textResponse.append(m_buffer);
   }
   if (!acknowledgeRcv())
      return false;

   printf("Text response:\n-----------------\n%s\n-----------------\n",m_textResponse.c_str());
   return true;
}

setProductFilePath()

bool ossimToolClient::setProductFilePath

(

const char *

filepath

)

Sets the local destination directory for file product.

The product file name used will match the server-side's file name. This method must be called prior to execute() for operations generating file products, otherwise the products are written to the client's temp directory. If the path directory specified does not exist, it will be created. Returns true if successful.

Definition at line 302 of file ossimToolClient.cpp.

References ossimFilename::createDirectory(), error(), ossimFilename::exists(), ossimFilename::isWriteable(), and m_prodFilePath.

Referenced by ossimToolClient().

{
   if (filepath == NULL)
      m_prodFilePath = "./";
   else
      m_prodFilePath = filepath;

   ostringstream xmsg;
   if (!m_prodFilePath.exists() && !m_prodFilePath.createDirectory())
   {
      xmsg <<"ERROR creating output directory: <"<<m_prodFilePath<<">"<<ends;
      error(xmsg.str().c_str());
   }
   else if (!m_prodFilePath.isWriteable())
   {
      xmsg <<"ERROR output directory: <"<<m_prodFilePath<<"> is not writable."<<ends;
      error(xmsg.str().c_str());
   }
   return true;
}

Member Data Documentation

m_buffer

char* ossimToolClient::m_buffer

protected

Definition at line 83 of file ossimToolClient.h.

Referenced by execute(), ossimToolClient(), receiveFile(), and receiveText().

m_prodFilePath

ossimFilename ossimToolClient::m_prodFilePath

protected

Definition at line 84 of file ossimToolClient.h.

Referenced by execute(), receiveFile(), and setProductFilePath().

m_svrsockfd

int ossimToolClient::m_svrsockfd

protected

Definition at line 82 of file ossimToolClient.h.

Referenced by acknowledgeRcv(), connectToServer(), disconnect(), execute(), receiveFile(), and receiveText().

m_textResponse

ossimString ossimToolClient::m_textResponse

protected

Definition at line 85 of file ossimToolClient.h.

Referenced by receiveFile(), and receiveText().

---

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

• ossimToolClient.h
• ossimToolClient.cpp