src/libgit2/ssh-wintunnel.h

   1 // TortoiseGit - a Windows shell extension for easy version control
   2
   3 // Copyright (C) 2014 TortoiseGit
   4 // Copyright (C) the libgit2 contributors. All rights reserved.
   5 //               - based on libgit2/include/git2/transport.h
   6
   7 // This program is free software; you can redistribute it and/or
   8 // modify it under the terms of the GNU General Public License
   9 // as published by the Free Software Foundation; either version 2
  10 // of the License, or (at your option) any later version.
  11
  12 // This program is distributed in the hope that it will be useful,
  13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
  14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15 // GNU General Public License for more details.
  16
  17 // You should have received a copy of the GNU General Public License
  18 // along with this program; if not, write to the Free Software Foundation,
  19 // 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  20 //
  21 #ifndef INCLUDE_git_transport_ssh_wintunnel_h__
  22 #define INCLUDE_git_transport_ssh_wintunnel_h__
  23
  24 //#include "transport.h"
  25
  26 /**
  27  * @file git2/transport.h
  28  * @brief Git transport interfaces and functions
  29  * @defgroup git_transport interfaces and functions
  30  * @ingroup Git
  31  * @{
  32  */
  33 GIT_BEGIN_DECL
  34
  35 /**
  36  * Create an instance of the ssh subtransport.
  37  *
  38  * Must be called by a wrapper, because this method does not match git_smart_subtransport_cb
  39  *
  40  * @param out The newly created subtransport
  41  * @param owner The smart transport to own this subtransport
  42  * @param sshtoolpath the path to the ssh helper tool (plink or ssh)
  43  * @param pEnv environment variables to be passed to the ssh helper tool
  44  * @return 0 or an error code
  45  */
  46 GIT_EXTERN(int) git_smart_subtransport_ssh_wintunnel(
  47         git_smart_subtransport **out,
  48         git_transport* owner,
  49         LPCWSTR sshtoolpath,
  50         LPWSTR pEnv);
  51
  52 /*
  53  *** End interface for subtransports for the smart transport ***
  54  */
  55
  56 /** @} */
  57 GIT_END_DECL
  58 #endif