Simple Updater

Simple Updater ist eine Bibliothek, mit der Sie einen Updater in einigen Codezeilen erstellen können (für Ihren Spielwerfer oder andere Projekte).
Diese Bibliothek ist in C# (.NET ≥ 4,6) und Java (JRE ≥ 1,8_80) eingebaut.
Laden Sie einfach die Bibliothek herunter, verweisen Sie auf Ihr Projekt und Sie können loslegen!
Überprüfen Sie den Dokumentbrüll, um sie zu verwenden! (Ein Beispielprojekt ist in der Quelle für jeden Zeitraum bereitgestellt)

Merkmale:

• Entwickelte sowohl in C# als auch Java
• Keine zusätzlichen Bibliotheken! Alles ist einheimisch.
• Einfache Integration
• Halten Sie den Client mit dem Server aktualisiert
• Löschen Sie alte oder unerwünschte Dateien, die nicht mit dem Server übereinstimmen
• Liste ignorieren
• Webclient -Konfiguration
• Kann das Serverergebnis für x Minuten/Sekunden zwischenspeichern (optional - kann eine lange Reaktion haben, wenn sie mit vielen Dateien deaktiviert werden).
• Auslösen von Ereignissen für jeden Schritt (Überprüfen von Dateien, Herunterladen, ...)
• Statuscode
• Fortschritt herunterladen
• Asynchroner Download
• Beispielprojekte vollständig kommentiert

Jeder Beitrag ist willkommen!
Aktuelle Version: 1.1

Inhaltsverzeichnis

• Präsentation
• Inhaltsverzeichnis
• Installation
  • Webserver
  • Kundenintegration
    • C#
    • JAVA
• Codedokumentation
  • Erstellen Sie das einfache Updater -Objekt
  • Funktion: Überprüfen Sie Dateien vom Server und löschen Sie veraltete Dateien
  • Funktion: Dateien herunterladen
  • Attribute von SimpleUpdater -Objekt
  • Ereignisse
  • Statuscode
• Beispielprojekt
• Kredit
• Lizenz

Installation

Webserver

Sie benötigen einen Webserver, um Dateien zu hosten, die der Updater heruntergeladen wird.

1. Klon/Laden Sie das Projekt herunter
2. Laden Sie Dateien hoch, die sich in "PHP - Server -Dateien" befinden
3. Überprüfen Sie den Index.php auf die Konfiguration
4. Erstellen Sie einen Ordner mit dem Namen "Dateien" im selben Verzeichnis wie die Index.php -Datei
5. Platzieren Sie alle Dateien, die Sie in den Ordner "Dateien" herunterladen möchten

Kundenintegration

C#

1. Gehen Sie zur Release -Seite und laden Sie die einfache Updater -Bibliothek herunter.
2. Verweisen Sie in Ihrem Projekt (Microsoft Tutorial)
3. Verwenden Sie das Objekt SimpleUpdater (siehe Dokumentation unten)

JAVA

1. Gehen Sie zur Release -Seite und laden Sie die einfache Updater -Bibliothek herunter.
2. Fügen Sie es in Ihr Projekt hinzu (ein Tutorial)
3. Verwenden Sie das Objekt SimpleUpdater (siehe Dokumentation unten)

Codedokumentation

Erstellen Sie das einfache Updater -Objekt.

 // We will keep 'updater' on all the documentation
SimpleUpdater updater = new SimpleUpdater ( server_url , installation_path ) ;

Parameter	Typ	Beschreibung
server_url	string / String	Die URL des Servers, auf dem Dateien heruntergeladen werden
Installation_Path	string / String	Der Pfad, in dem Dateien heruntergeladen werden (seien Sie vorsichtig, wenn Sie nicht korrekt eingestellt sind, kann er falsche Dateien löschen)

Funktion: Überprüfen Sie Dateien vom Server und löschen Sie veraltete Dateien (halten Sie aktualisiert).

 updater . CheckFilesFromServerAndDeleteOutdated ( ) ;

Beschreibung: Diese Funktion kontaktiert den Server, um alle Dateien zu erhalten und alle lokalen Dateien und Verzeichnisse zu durchsuchen, die Dateien gelöscht, heruntergeladen oder ignoriert werden müssen. Dateien, die gelöscht werden müssen, werden automatisch gelöscht.

Diese Funktion muss vor dem Herunterladen von Dateien aufgerufen werden.

Funktion: Dateien herunterladen

 updater . DownloadFiles ( ) ;

Beschreibung: Dadurch wird alle Dateien heruntergeladen, die in die mit der Erstellung des SimpleUpdater -Objekts gelieferte installation_path heruntergeladen werden müssen.

Attribute von SimpleUpdater -Objekt

Name (C#)	Funktion (Java)	Typ	Beschreibung
Server_url	getServerUrl()	string / String	Die URL des Servers, auf dem Dateien heruntergeladen werden
Installation_Path	getInstallationPath()	string / String	Der Pfad, in dem Dateien heruntergeladen werden
Candownload	CanDownload()	bool / Boolean	Überprüfen Sie, ob Sie den Download von Dateien beginnen können
Cancheck	CanCheck()	bool / Boolean	Überprüfen Sie, ob Sie den Überprüfungsprozess lokaler Dateien starten können
NumberOfByTestodownload	getNumberOfBytesToDownlaod()	long	Holen Sie sich die Anzahl der Bytes, die heruntergeladen werden
Statuscode	getStatusCode()	int	Holen Sie sich den Statuscode

Ereignisse

Name	Args	Beschreibung
ONCHECKFINISHED	int nbrLocalFiles int nbrServerFiles int nbrFilesToDownload int nbrFilesDeleted long numberOfBytesToDownload	Ereignis ausgelöst, wenn der Überprüfungsprozess endet
Loadfineed	long TotalBytesDownloaded	Ereignis ausgelöst, wenn der Download endet
OndownloadProgresschanged	long TotalBytesDownloaded float percent	Ereignis ausgelöst jedes Mal, wenn sich der Download -Fortschritt änderte
OnStatuschanged	int code	Ereignis ausgelöst, wenn sich der Status der Updater ändert

In der Java -Version müssen Sie eine Klasse erstellen und die SimpleUpdaterEvents -Klasse implementieren. Erstellen Sie eine Instanz dieser Klasse und fügen Sie sie mit updater.addListener(yourEventClassObject) zu den Hörern von SimpleUpdater Object hinzu.
Weitere Informationen finden Sie im Java -Beispielprojekt.

Statuscode

Code	Beschreibung
0	Warten auf Aktion
1	Wenden Sie sich an den Server, um Dateien zu analysieren
2	Suchen und löschen lokale Dateien
3	Überprüfen Sie fertig Ausgelöst nach check_finished (...)
4	Download gestartet
5	Eine Datei wurde erfolgreich heruntergeladen
6	Ein Fehler, der beim Herunterladen einer Datei aufgetreten ist
7	Bei einem Fehler wird versucht, auf den Server zuzugreifen
8	Download fertig Ausgelöst nach Download_finisht (...)

Beispielprojekte

C#

Das Beispielprojekt wird vollständig kommentiert. Sie finden es in C# - Beispiel Project Simple Updater .

JAVA

Dieses Beispielprojekt, wenn vollständig kommentiert. Es druckt Debugg in die Konsole. Sie finden es in 'Java - Simple Updater Library' .

Kredit

• EN0 - Flavien Darche

Lizenz

MIT License