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
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
|
/*
socket handling routines
Copyright (C) 1998, Joe Orton <joe@orton.demon.co.uk>, except where
otherwise indicated.
This program is free software; you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation; either version 2 of the License, or
(at your option) any later version.
This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with this program; if not, write to the Free Software
Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
*/
#ifndef SOCKET_H
#define SOCKET_H
#include <sys/socket.h>
#include <sys/types.h>
#include <netinet/in.h>
/* Socket read timeout */
#define SOCKET_TIMEOUT 30
/* sock_read is read() with a timeout of SOCKET_TIMEOUT.
* Returns:
* -1 on error,
* 0 on no data to read (due to timeout or EOF),
* >0 length of data read into buffer.
*/
int sock_read( const int sock, void *buffer, const size_t count );
/* sock_recv is recv() with a timeout of SOCKET_TIMEOUT.
* Returns:
* -1 on error,
* 0 on no data to read (due to timeout or EOF),
* >0 length of data read into buffer.
*/
int sock_recv( const int sock, void *buffer, const size_t count,
const unsigned int flags);
/* Blocks waiting for data on the given socket for the given time.
* Returns:
* -1 on error,
* 0 on no data within timeout,
* 1 if data arrived on the socket.
*/
int sock_block( const int sock, const int timeout );
/* Dump the given filename down the given socket.
* Returns non-zero value if successful */
int send_file( const int sock, const char *filename );
/* Dump the blah blah in ASCII mode */
int send_file_ascii( const int sock, const char *filename );
/* Dump from given socket into given file. Reads only filesize bytes,
* or until EOF if filesize == -1.
* Returns number of bytes written on success, or -1 on error */
int recv_file( const int sock, const char *filename, const size_t filesize );
/* Reads readlen bytes from srcfd and writes to destfd.
* (Not all in one go, obviously).
* If readlen == -1, then it reads from srcfd until EOF.
* Returns number of bytes written to destfd, or -1 on error.
* Calls fe_transfer_progress( a, b ) during transfers, where
* a = bytes transferred so far, and b = readlen
*/
size_t transfer( const int srcfd, const int destfd, const size_t readlen );
/* Sends the given line to given socket, CRLF appended */
int send_line( const int sock, const char *line );
/* Sends the given block of data down the socket */
int send_data( const int sock, const char *data, const size_t length );
/* Sends the null-terminated string down the given socket */
int send_string( const int sock, const char *string );
/* Reads a line from given socket */
int read_line( const int sock, char *line, int len );
/* Reads a chunk of data. */
int read_data( const int sock, char *buffer, int buflen );
/* Creates and connects a socket */
int socket_connect( const struct in_addr host, const int portnum );
void socket_close( const int socket );
/* Do a name lookup on given hostname, writes the address into
* given address buffer. Return -1 on failure.
*/
int host_lookup( const char *hostname, struct in_addr *addr );
/* Returns the standard TCP port for the given service */
int get_tcp_port( const char *name );
#endif /* SOCKET_H */
|
