tftp_context Struct Reference

#include <tftp_server.h>

Collaboration diagram for tftp_context:

Public Attributes
void *(*	open )(const char *fname, const char *mode, u8_t write)
void(*	close )(void *handle)
int(*	read )(void *handle, void *buf, int bytes)
int(*	write )(void *handle, struct pbuf *p)

Detailed Description

TFTP context containing callback functions for TFTP transfers

Member Data Documentation

open

void*(* tftp_context::open) (const char *fname, const char *mode, u8_t write)

Open file for read/write.

Parameters

fname	Filename
mode	Mode string from TFTP RFC 1350 (netascii, octet, mail)
write	Flag indicating read (0) or write (!= 0) access

Returns

File handle supplied to other functions

close

void(* tftp_context::close) (void *handle)

Close file handle

Parameters

handle

File handle returned by open()

read

int(* tftp_context::read) (void *handle, void *buf, int bytes)

Read from file

Parameters

handle	File handle returned by open()
buf	Target buffer to copy read data to
bytes	Number of bytes to copy to buf

Returns

>= 0: Success; < 0: Error

write

int(* tftp_context::write) (void *handle, struct pbuf *p)

Write to file

Parameters

handle	File handle returned by open()
pbuf	PBUF adjusted such that payload pointer points to the beginning of write data. In other words, TFTP headers are stripped off.

Returns

>= 0: Success; < 0: Error