UbixOS V2  2.0
tftp_context Struct Reference

#include <tftp_server.h>

Collaboration diagram for tftp_context:
Collaboration graph

Data Fields

void(* close )(void *handle)
 
void *(* open )(const char *fname, const char *mode, u8_t write)
 
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

Definition at line 55 of file tftp_server.h.

Field Documentation

◆ close

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

Close file handle

Parameters
handleFile handle returned by open()

Definition at line 68 of file tftp_server.h.

◆ open

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

Open file for read/write.

Parameters
fnameFilename
modeMode string from TFTP RFC 1350 (netascii, octet, mail)
writeFlag indicating read (0) or write (!= 0) access
Returns
File handle supplied to other functions

Definition at line 63 of file tftp_server.h.

◆ read

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

Read from file

Parameters
handleFile handle returned by open()
bufTarget buffer to copy read data to
bytesNumber of bytes to copy to buf
Returns
>= 0: Success; < 0: Error

Definition at line 76 of file tftp_server.h.

◆ write

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

Write to file

Parameters
handleFile handle returned by open()
pbufPBUF 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

Definition at line 85 of file tftp_server.h.


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