Slicer  5.0
Slicer is a multi-platform, free and open source software package for visualization and medical image computing
List of all members | Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions
vtkHTTPHandler Class Reference

#include <Libs/RemoteIO/vtkHTTPHandler.h>

Inheritance diagram for vtkHTTPHandler:
Inheritance graph
[legend]
Collaboration diagram for vtkHTTPHandler:
Collaboration graph
[legend]

Public Types

typedef vtkURIHandler Superclass
 
- Public Types inherited from vtkURIHandler
typedef vtkObject Superclass
 

Public Member Functions

int CanHandleURI (const char *uri) override
 
int CloseTransfer () override
 
virtual const char * GetClassName ()
 
int GetForbidReuse ()
 
void InitTransfer () override
 NOTE: Subclasses should implement these method. More...
 
virtual int IsA (const char *type)
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
void SetForbidReuse (int value)
 
void StageFileRead (const char *source, const char *destination) override
 This function wraps curl functionality to download a specified URL to a specified dir. More...
 
virtual void StageFileRead (const char *source, const char *destination)
 
virtual void StageFileRead (const char *source, const char *destination, const char *username, const char *password, const char *hostname)
 
various Read/Write method footprints useful to redefine in specific handlers. More...
 
void StageFileWrite (const char *source, const char *destination) override
 
virtual void StageFileWrite (const char *source, const char *username, const char *password, const char *hostname, const char *sessionID)
 
virtual void StageFileWrite (const char *source, const char *destination)
 
- Public Member Functions inherited from vtkURIHandler
size_t BufferedWrite (char *buffer, size_t size, size_t nitems)
 
This function writes the downloaded data in a buffered manner More...
 
virtual int CanHandleURI (const char *vtkNotUsed(uri))
 need something that goes the other way too... More...
 
virtual char * GetHostName ()
 
virtual char * GetName ()
 
virtual vtkPermissionPrompterGetPermissionPrompter ()
 
virtual char * GetPrefix ()
 
virtual int GetRequiresPermission ()
 
void PrintSelf (ostream &os, vtkIndent indent) override
 
int ProgressCallback (FILE *outputFile, double dltotal, double dlnow, double ultotal, double ulnow)
 
This function gives us some feedback on how our download is going. More...
 
virtual void SetHostName (const char *)
 
virtual void SetLocalFile (FILE *localFile)
 
Use this function to set LocalFile More...
 
virtual void SetName (const char *)
 
virtual void SetPermissionPrompter (vtkPermissionPrompter *prompter)
 
virtual void SetPrefix (const char *)
 
virtual void SetRequiresPermission (int)
 
virtual void StageFileRead (const char *source, const char *destination, const char *username, const char *password, const char *hostname)
 
various Read/Write method footprints useful to redefine in specific handlers. More...
 
virtual void StageFileWrite (const char *source, const char *username, const char *password, const char *hostname, const char *sessionID)
 

Static Public Member Functions

static int IsTypeOf (const char *type)
 
static vtkHTTPHandlerNew ()
 The Usual vtk class functions. More...
 
static vtkHTTPHandlerSafeDownCast (vtkObject *o)
 
- Static Public Member Functions inherited from vtkURIHandler
static int IsTypeOf (const char *type)
 
static vtkURIHandlerNew ()
 The Usual vtk class functions. More...
 
static vtkURIHandlerSafeDownCast (vtkObject *o)
 

Protected Member Functions

void operator= (const vtkHTTPHandler &)
 
 vtkHTTPHandler ()
 
 vtkHTTPHandler (const vtkHTTPHandler &)
 
 ~vtkHTTPHandler () override
 
- Protected Member Functions inherited from vtkURIHandler
void operator= (const vtkURIHandler &)
 
 vtkURIHandler ()
 
 vtkURIHandler (const vtkURIHandler &)
 
 ~vtkURIHandler () override
 

Additional Inherited Members

- Protected Attributes inherited from vtkURIHandler
char * HostName
 
FILE * LocalFile
 
local file, it gets passed to C functions in libcurl More...
 
char * Name
 
char * Prefix
 

Detailed Description

Definition at line 15 of file vtkHTTPHandler.h.

Member Typedef Documentation

◆ Superclass

Definition at line 21 of file vtkHTTPHandler.h.

Constructor & Destructor Documentation

◆ vtkHTTPHandler() [1/2]

vtkHTTPHandler::vtkHTTPHandler ( )
protected

◆ ~vtkHTTPHandler()

vtkHTTPHandler::~vtkHTTPHandler ( )
overrideprotected

◆ vtkHTTPHandler() [2/2]

vtkHTTPHandler::vtkHTTPHandler ( const vtkHTTPHandler )
protected

Member Function Documentation

◆ CanHandleURI()

int vtkHTTPHandler::CanHandleURI ( const char *  uri)
override

This methods returns 1 if the handler matches the uri's required protocol and returns 0 if it's not appropriate for the uri.

◆ CloseTransfer()

int vtkHTTPHandler::CloseTransfer ( )
overridevirtual

Reimplemented from vtkURIHandler.

◆ GetClassName()

virtual const char* vtkHTTPHandler::GetClassName ( )
virtual

Reimplemented from vtkURIHandler.

◆ GetForbidReuse()

int vtkHTTPHandler::GetForbidReuse ( )

◆ InitTransfer()

void vtkHTTPHandler::InitTransfer ( )
overridevirtual

NOTE: Subclasses should implement these method.

Reimplemented from vtkURIHandler.

◆ IsA()

virtual int vtkHTTPHandler::IsA ( const char *  type)
virtual

Reimplemented from vtkURIHandler.

◆ IsTypeOf()

static int vtkHTTPHandler::IsTypeOf ( const char *  type)
static

◆ New()

static vtkHTTPHandler* vtkHTTPHandler::New ( )
static

The Usual vtk class functions.

◆ operator=()

void vtkHTTPHandler::operator= ( const vtkHTTPHandler )
protected

◆ PrintSelf()

void vtkHTTPHandler::PrintSelf ( ostream &  os,
vtkIndent  indent 
)
override

◆ SafeDownCast()

static vtkHTTPHandler* vtkHTTPHandler::SafeDownCast ( vtkObject *  o)
static

◆ SetForbidReuse()

void vtkHTTPHandler::SetForbidReuse ( int  value)

Some web servers don't handle 'keep alive' socket transactions in a way that's compatible with curl on windows. When this flag is set curl will do one transaction per connection with the side-effect that more network resources are used (so avoid this if you can).

◆ StageFileRead() [1/3]

void vtkHTTPHandler::StageFileRead ( const char *  source,
const char *  destination 
)
overridevirtual

This function wraps curl functionality to download a specified URL to a specified dir.

Reimplemented from vtkURIHandler.

◆ StageFileRead() [2/3]

virtual void vtkURIHandler::StageFileRead


various Read/Write method footprints useful to redefine in specific handlers.

◆ StageFileRead() [3/3]

virtual void vtkURIHandler::StageFileRead

virtual methods to be defined in subclasses. (Maybe these should be defined to handle default file operations)

◆ StageFileWrite() [1/3]

void vtkHTTPHandler::StageFileWrite ( const char *  source,
const char *  destination 
)
overridevirtual

Reimplemented from vtkURIHandler.

◆ StageFileWrite() [2/3]

virtual void vtkURIHandler::StageFileWrite

◆ StageFileWrite() [3/3]

virtual void vtkURIHandler::StageFileWrite

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