Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Real Time communication library using Animated Gifs as a transport™

branch: master

This branch is 0 commits ahead and 0 commits behind master

Fetching latest commit…

Cannot retrieve the latest commit at this time

README.md

gifsockets

"This library is the websockets of the '90s" - Somebody at Hacker News.

This library demoes how to achieve realtime text communication using GIF images as transport.

Mind Blown

The interesting part is that you can even use IE6 with this library and get the data in Real Time (TM).

Of course this should have been delivered as an April's Fools joke but sadly we are in mid September here in the northern hemisphere.

See it in action in this video: https://vimeo.com/49447841.

How does it work

The idea is pretty simple. We use Animated Gif images to stream data in real time to the browser. Since a gif image doesn't specify how many frames it has, once the browser opens it, it will keep waiting for new frames until you send the bits indicating that there's no more image to fetch.

Pretty simple uh!

And yes. It works in IE6.

Usage

The usage now is a bit rudimentary and manual. Feel free to improve it and send a PR.

$ git clone git://github.com/videlalvaro/gifsockets.git
$ cd gifsockets
$ lein deps
% lein repl

Then perform the following commands on the Clojure REPL.

;; in the repl do the following to import the libs
(use 'gifsockets.core)
(use 'gifsockets.server)
;;
;;Then we declare the tcp server
(def server (tcp-server :port 8081 :handler gif-handler))
(start2 server)
;; wait for a browser connection on port 8081
;; go and open http://localhost:8081/ in Safari or IE6
;; In Chrome it works a bit laggy and in Firefox it doesn't work at all
;;
;; Now let's create the gif encoder that we use to write messages to the browser.
(def encoder (create-gif (.getOutputStream client)))
;;
;;Now we are ready to send messages to that browser client
(add-message encoder "Hello gif-sockets")
;; now you should see a GIF image with the new message on it.
(add-message encoder "Zup zup zup")
(add-message encoder "And so forth")
;;
;; Now let's clean up and close the connection
(.finish encoder)
(.close client)

As you can see from the code this handles only one connection in what is called an UPoC (Uber Proof Of Concept).

Possible uses:

All joking aside I think this is a very low tech way to have say, a website where you could tail logs for instance and you need to do it with a browser that have zero websockets support or something like that.

Or what about progress bars for stuff that your server is doing in the background, say, while it resizes an image?

Yes. You need gifsockets.

NOTE:

If you need a good library for real time communications on the web then I would recommend using sockjs.

License

Copyright © 2012 Alvaro Videla

The following classes:

  • AnimatedGifEncoder.java
  • GifDecoder.java
  • LZWEncoder.java
  • NeuQuant.java

were taken from this website: http://www.fmsware.com/stuff/gif.html.

And the server code was taken from here https://github.com/weavejester/tcp-server

The awesome image that illustrates this page was given by the internet.

Distributed under the Eclipse Public License, the same as Clojure.

CREDITS

I've stole this idea (ehem, took inspiration) from a chat a colleague showed me like three years ago. It wasn't open source back then and I was always wondering how to implement something like that. So kudos to Ka-Ping Yee, who had the original idea.

Thanks simonw for posting the link to the original chat.

Something went wrong with that request. Please try again.