Go to file
Duke b10f4eab91 Rename README to README.md 2014-01-23 23:05:15 -02:00
testdata fixed links when rss has atom:link e link tag [#21] 2014-01-18 15:41:26 -02:00
LICENSE Switch to more liberal CC0 Public Domain license. 2011-03-19 14:48:01 +01:00
README.md Rename README to README.md 2014-01-23 23:05:15 -02:00
atom.go Removes new Item notification 2013-12-05 14:21:32 +01:00
author.go Making package easily usable with goinstall. Including the reference to go-pkg-xmlx and the build target in the makefile. 2011-01-20 22:57:04 +01:00
category.go Making package easily usable with goinstall. Including the reference to go-pkg-xmlx and the build target in the makefile. 2011-01-20 22:57:04 +01:00
channel.go Adds Key() 2013-12-05 16:04:00 +01:00
cloud.go Making package easily usable with goinstall. Including the reference to go-pkg-xmlx and the build target in the makefile. 2011-01-20 22:57:04 +01:00
content.go Making package easily usable with goinstall. Including the reference to go-pkg-xmlx and the build target in the makefile. 2011-01-20 22:57:04 +01:00
database.go Adds a database. 2013-12-05 15:30:26 +01:00
enclosure.go Making package easily usable with goinstall. Including the reference to go-pkg-xmlx and the build target in the makefile. 2011-01-20 22:57:04 +01:00
feed.go Add check if the handler exists. 2013-12-05 16:23:32 +01:00
feed_test.go fixed links when rss has atom:link e link tag [#21] 2014-01-18 15:41:26 -02:00
generator.go Making package easily usable with goinstall. Including the reference to go-pkg-xmlx and the build target in the makefile. 2011-01-20 22:57:04 +01:00
image.go Making package easily usable with goinstall. Including the reference to go-pkg-xmlx and the build target in the makefile. 2011-01-20 22:57:04 +01:00
input.go Making package easily usable with goinstall. Including the reference to go-pkg-xmlx and the build target in the makefile. 2011-01-20 22:57:04 +01:00
item.go Adds a fallback ID function. 2013-12-05 16:18:13 +01:00
link.go Making package easily usable with goinstall. Including the reference to go-pkg-xmlx and the build target in the makefile. 2011-01-20 22:57:04 +01:00
rss.go fixed links when rss has atom:link e link tag [#21] 2014-01-18 15:41:26 -02:00
source.go Making package easily usable with goinstall. Including the reference to go-pkg-xmlx and the build target in the makefile. 2011-01-20 22:57:04 +01:00
subtitle.go Making package easily usable with goinstall. Including the reference to go-pkg-xmlx and the build target in the makefile. 2011-01-20 22:57:04 +01:00

README.md

RSS

This package allows us to fetch Rss and Atom feeds from the internet. They are parsed into an object tree which is a hybrid of both the RSS and Atom standards.

Supported feeds are:

  • Rss v0.91, 0.92 and 2.0
  • Atom 1.0

The package allows us to maintain cache timeout management. This prevents us from querying the servers for feed updates too often and risk ip bans. Apart from setting a cache timeout manually, the package also optionally adheres to the TTL, SkipDays and SkipHours values specified in the feeds themselves.

Note that the TTL, SkipDays and SkipHour fields are only part of the RSS spec. For Atom feeds, we use the CacheTimeout in the Feed struct.

Because the object structure is a hybrid between both RSS and Atom specs, not all fields will be filled when requesting either an RSS or Atom feed. I have tried to create as many shared fields as possible but some of them simply do not occur in either the RSS or Atom spec.

The Feed object supports notifications of new channels and items. This is achieved by passing 2 function handlers to the feeder.New() function. They will be called whenever a feed is updated from the remote source and either a new channel or a new item is found that previously did not exist. This allows you to easily monitor a feed for changes. See src/feed_test.go for an example of how this works.

DEPENDENCIES

github.com/jteeuwen/go-pkg-xmlx

USAGE

An idiomatic example program can be found in example.go.