summaryrefslogtreecommitdiff
path: root/apps/JAWS/clients/Blobby/Blob.h
blob: 293e530e69648ca5b8b7ccaace29c99f80ffc412 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
/* -*- C++ -*- */
// $Id$

//============================================================================
//
// = LIBRARY
//    JAWS
//
// = FILENAME
//    Blob.h
//
// = DESCRIPTION
//     This is the ACE_Blob class, which is the API for doing file
//     uploads/downloads.
//
// = AUTHOR
//    Prashant Jain and Sumedh Mungee
//
//============================================================================

#ifndef ACE_BLOB_H
#define ACE_BLOB_H

#include "ace/OS.h"

#if !defined (ACE_LACKS_PRAGMA_ONCE)
# pragma once
#endif /* ACE_LACKS_PRAGMA_ONCE */

#include "ace/Connector.h"
#include "ace/INET_Addr.h"
#include "ace/Svc_Handler.h"
#include "ace/SOCK_Connector.h"
#include "ace/Message_Block.h"
#include "Blob_Handler.h"

class ACE_Blob
  // = TITLE
  //     Blob is intended to provide application API to
  //     classes that wish to do network i/o at a very
  //     high level of abstraction.
  //
  // = This class provides the ability to retrieve data from
  //   the network, of specified length and offset, and potentially
  //   use any protocol "under the hood" to do so. It currently
  //   uses HTTP. See Blob_Handler also.
{
public:
  ACE_Blob (void);
  ~ACE_Blob (void);

  int open (char *filename,
            char *hostname =  ACE_DEFAULT_SERVER_HOST ,
            u_short port = 80);
  // initializes the class with the given filename, hostname and port.
  // it should be called with the filename, before any read/write calls


  int read (ACE_Message_Block *mb, size_t length, size_t offset);
  // starts a connection, and reads a file from the server,
  //   of length and offset as specified, into Message_Block mb
  //   The message block should have capacity to hold length number
  //   of bytes

  int write (ACE_Message_Block *mb, size_t length, size_t offset);
  // starts a connection, and writes a file to the server,
  //   of length and offset as specified, from Message_Block mb
  //   thus the message block should contain atleast length + offset
  //   bytes of data


  int close ();
  // Frees memory allocated for filename.

private:
  ACE_INET_Addr inet_addr_;
  // store the internet address of the server

  char *filename_;
  // The filename

  ACE_Connector<ACE_Blob_Handler, ACE_SOCK_CONNECTOR> connector_;
  // The connector endpoint to initiate the client connection

};

#endif /* ACE_BLOB_H */